98
238
class AvahiService(object):
239
"""An Avahi (Zeroconf) service.
100
242
interface: integer; avahi.IF_UNSPEC or an interface index.
101
243
Used to optionally bind to the specified interface.
102
name = string; Example: "Mandos"
103
type = string; Example: "_mandos._tcp".
104
See <http://www.dns-sd.org/ServiceTypes.html>
105
port = integer; what port to announce
106
TXT = list of strings; TXT record for the service
107
domain = string; Domain to publish on, default to .local if empty.
108
host = string; Host to publish records for, default to localhost
110
max_renames = integer; maximum number of renames
111
rename_count = integer; counter so we only rename after collisions
112
a sensible number of times
244
name: string; Example: 'Mandos'
245
type: string; Example: '_mandos._tcp'.
246
See <https://www.iana.org/assignments/service-names-port-numbers>
247
port: integer; what port to announce
248
TXT: list of strings; TXT record for the service
249
domain: string; Domain to publish on, default to .local if empty.
250
host: string; Host to publish records for, default is localhost
251
max_renames: integer; maximum number of renames
252
rename_count: integer; counter so we only rename after collisions
253
a sensible number of times
254
group: D-Bus Entry Group
256
bus: dbus.SystemBus()
114
259
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
260
servicetype = None, port = None, TXT = None,
261
domain = "", host = "", max_renames = 32768,
262
protocol = avahi.PROTO_UNSPEC, bus = None):
118
263
self.interface = interface
265
self.type = servicetype
267
self.TXT = TXT if TXT is not None else []
126
268
self.domain = domain
128
270
self.rename_count = 0
271
self.max_renames = max_renames
272
self.protocol = protocol
273
self.group = None # our entry group
276
self.entry_group_state_changed_match = None
129
278
def rename(self):
130
279
"""Derived from the Avahi example code"""
131
280
if self.rename_count >= self.max_renames:
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
281
logger.critical("No suitable Zeroconf service name found"
282
" after %i retries, exiting.",
134
284
raise AvahiServiceError("Too many renames")
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
285
self.name = str(self.server
286
.GetAlternativeServiceName(self.name))
287
logger.info("Changing Zeroconf service name to %r ...",
292
except dbus.exceptions.DBusException as error:
293
logger.critical("D-Bus Exception", exc_info=error)
139
296
self.rename_count += 1
140
298
def remove(self):
141
299
"""Derived from the Avahi example code"""
142
if group is not None:
300
if self.entry_group_state_changed_match is not None:
301
self.entry_group_state_changed_match.remove()
302
self.entry_group_state_changed_match = None
303
if self.group is not None:
145
307
"""Derived from the Avahi example code"""
148
group = dbus.Interface\
149
(bus.get_object(avahi.DBUS_NAME,
150
server.EntryGroupNew()),
151
avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
group.connect_to_signal('StateChanged',
153
entry_group_state_changed)
154
logger.debug(u"Adding service '%s' of type '%s' ...",
155
service.name, service.type)
157
self.interface, # interface
158
avahi.PROTO_INET6, # protocol
159
dbus.UInt32(0), # flags
160
self.name, self.type,
161
self.domain, self.host,
162
dbus.UInt16(self.port),
163
avahi.string_array_to_txt_array(self.TXT))
166
# From the Avahi example code:
167
group = None # our entry group
168
# End of Avahi example code
309
if self.group is None:
310
self.group = dbus.Interface(
311
self.bus.get_object(avahi.DBUS_NAME,
312
self.server.EntryGroupNew()),
313
avahi.DBUS_INTERFACE_ENTRY_GROUP)
314
self.entry_group_state_changed_match = (
315
self.group.connect_to_signal(
316
'StateChanged', self.entry_group_state_changed))
317
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
318
self.name, self.type)
319
self.group.AddService(
322
dbus.UInt32(0), # flags
323
self.name, self.type,
324
self.domain, self.host,
325
dbus.UInt16(self.port),
326
avahi.string_array_to_txt_array(self.TXT))
329
def entry_group_state_changed(self, state, error):
330
"""Derived from the Avahi example code"""
331
logger.debug("Avahi entry group state change: %i", state)
333
if state == avahi.ENTRY_GROUP_ESTABLISHED:
334
logger.debug("Zeroconf service established.")
335
elif state == avahi.ENTRY_GROUP_COLLISION:
336
logger.info("Zeroconf service name collision.")
338
elif state == avahi.ENTRY_GROUP_FAILURE:
339
logger.critical("Avahi: Error in group state changed %s",
341
raise AvahiGroupError("State changed: {!s}"
345
"""Derived from the Avahi example code"""
346
if self.group is not None:
349
except (dbus.exceptions.UnknownMethodException,
350
dbus.exceptions.DBusException):
355
def server_state_changed(self, state, error=None):
356
"""Derived from the Avahi example code"""
357
logger.debug("Avahi server state change: %i", state)
358
bad_states = { avahi.SERVER_INVALID:
359
"Zeroconf server invalid",
360
avahi.SERVER_REGISTERING: None,
361
avahi.SERVER_COLLISION:
362
"Zeroconf server name collision",
363
avahi.SERVER_FAILURE:
364
"Zeroconf server failure" }
365
if state in bad_states:
366
if bad_states[state] is not None:
368
logger.error(bad_states[state])
370
logger.error(bad_states[state] + ": %r", error)
372
elif state == avahi.SERVER_RUNNING:
376
logger.debug("Unknown state: %r", state)
378
logger.debug("Unknown state: %r: %r", state, error)
381
"""Derived from the Avahi example code"""
382
if self.server is None:
383
self.server = dbus.Interface(
384
self.bus.get_object(avahi.DBUS_NAME,
385
avahi.DBUS_PATH_SERVER,
386
follow_name_owner_changes=True),
387
avahi.DBUS_INTERFACE_SERVER)
388
self.server.connect_to_signal("StateChanged",
389
self.server_state_changed)
390
self.server_state_changed(self.server.GetState())
393
class AvahiServiceToSyslog(AvahiService):
395
"""Add the new name to the syslog messages"""
396
ret = AvahiService.rename(self)
397
syslogger.setFormatter(logging.Formatter
398
('Mandos ({}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
171
404
class Client(object):
172
405
"""A representation of a client host served by this server.
174
name: string; from the config file, used in log messages
408
approved: bool(); 'None' if not yet approved/disapproved
409
approval_delay: datetime.timedelta(); Time to wait for approval
410
approval_duration: datetime.timedelta(); Duration of one approval
411
checker: subprocess.Popen(); a running checker process used
412
to see if the client lives.
413
'None' if no process is running.
414
checker_callback_tag: a gobject event source tag, or None
415
checker_command: string; External command which is run to check
416
if client lives. %() expansions are done at
417
runtime with vars(self) as dict, so that for
418
instance %(name)s can be used in the command.
419
checker_initiator_tag: a gobject event source tag, or None
420
created: datetime.datetime(); (UTC) object creation
421
client_structure: Object describing what attributes a client has
422
and is used for storing the client at exit
423
current_checker_command: string; current running checker_command
424
disable_initiator_tag: a gobject event source tag, or None
175
426
fingerprint: string (40 or 32 hexadecimal digits); used to
176
427
uniquely identify the client
177
secret: bytestring; sent verbatim (over TLS) to client
178
fqdn: string (FQDN); available for use by the checker command
179
created: datetime.datetime(); object creation, not client host
180
last_checked_ok: datetime.datetime() or None if not yet checked OK
181
timeout: datetime.timedelta(); How long from last_checked_ok
182
until this client is invalid
183
interval: datetime.timedelta(); How often to start a new checker
184
stop_hook: If set, called by stop() as stop_hook(self)
185
checker: subprocess.Popen(); a running checker process used
186
to see if the client lives.
187
'None' if no process is running.
188
checker_initiator_tag: a gobject event source tag, or None
189
stop_initiator_tag: - '' -
190
checker_callback_tag: - '' -
191
checker_command: string; External command which is run to check if
192
client lives. %() expansions are done at
193
runtime with vars(self) as dict, so that for
194
instance %(name)s can be used in the command.
196
_timeout: Real variable for 'timeout'
197
_interval: Real variable for 'interval'
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
199
_interval_milliseconds: - '' -
428
host: string; available for use by the checker command
429
interval: datetime.timedelta(); How often to start a new checker
430
last_approval_request: datetime.datetime(); (UTC) or None
431
last_checked_ok: datetime.datetime(); (UTC) or None
432
last_checker_status: integer between 0 and 255 reflecting exit
433
status of last checker. -1 reflects crashed
434
checker, -2 means no checker completed yet.
435
last_enabled: datetime.datetime(); (UTC) or None
436
name: string; from the config file, used in log messages and
438
secret: bytestring; sent verbatim (over TLS) to client
439
timeout: datetime.timedelta(); How long from last_checked_ok
440
until this client is disabled
441
extended_timeout: extra long timeout when secret has been sent
442
runtime_expansions: Allowed attributes for runtime expansion.
443
expires: datetime.datetime(); time (UTC) when a client will be
445
server_settings: The server_settings dict from main()
201
def _set_timeout(self, timeout):
202
"Setter function for 'timeout' attribute"
203
self._timeout = timeout
204
self._timeout_milliseconds = ((self.timeout.days
205
* 24 * 60 * 60 * 1000)
206
+ (self.timeout.seconds * 1000)
207
+ (self.timeout.microseconds
209
timeout = property(lambda self: self._timeout,
212
def _set_interval(self, interval):
213
"Setter function for 'interval' attribute"
214
self._interval = interval
215
self._interval_milliseconds = ((self.interval.days
216
* 24 * 60 * 60 * 1000)
217
+ (self.interval.seconds
219
+ (self.interval.microseconds
221
interval = property(lambda self: self._interval,
224
def __init__(self, name=None, stop_hook=None, fingerprint=None,
225
secret=None, secfile=None, fqdn=None, timeout=None,
226
interval=-1, checker=None):
227
"""Note: the 'checker' argument sets the 'checker_command'
228
attribute and not the 'checker' attribute.."""
448
runtime_expansions = ("approval_delay", "approval_duration",
449
"created", "enabled", "expires",
450
"fingerprint", "host", "interval",
451
"last_approval_request", "last_checked_ok",
452
"last_enabled", "name", "timeout")
453
client_defaults = { "timeout": "PT5M",
454
"extended_timeout": "PT15M",
456
"checker": "fping -q -- %%(host)s",
458
"approval_delay": "PT0S",
459
"approval_duration": "PT1S",
460
"approved_by_default": "True",
465
def config_parser(config):
466
"""Construct a new dict of client settings of this form:
467
{ client_name: {setting_name: value, ...}, ...}
468
with exceptions for any special settings as defined above.
469
NOTE: Must be a pure function. Must return the same result
470
value given the same arguments.
473
for client_name in config.sections():
474
section = dict(config.items(client_name))
475
client = settings[client_name] = {}
477
client["host"] = section["host"]
478
# Reformat values from string types to Python types
479
client["approved_by_default"] = config.getboolean(
480
client_name, "approved_by_default")
481
client["enabled"] = config.getboolean(client_name,
484
client["fingerprint"] = (section["fingerprint"].upper()
486
if "secret" in section:
487
client["secret"] = section["secret"].decode("base64")
488
elif "secfile" in section:
489
with open(os.path.expanduser(os.path.expandvars
490
(section["secfile"])),
492
client["secret"] = secfile.read()
494
raise TypeError("No secret or secfile for section {}"
496
client["timeout"] = string_to_delta(section["timeout"])
497
client["extended_timeout"] = string_to_delta(
498
section["extended_timeout"])
499
client["interval"] = string_to_delta(section["interval"])
500
client["approval_delay"] = string_to_delta(
501
section["approval_delay"])
502
client["approval_duration"] = string_to_delta(
503
section["approval_duration"])
504
client["checker_command"] = section["checker"]
505
client["last_approval_request"] = None
506
client["last_checked_ok"] = None
507
client["last_checker_status"] = -2
511
def __init__(self, settings, name = None, server_settings=None):
230
logger.debug(u"Creating client %r", self.name)
231
# Uppercase and remove spaces from fingerprint
232
# for later comparison purposes with return value of
233
# the fingerprint() function
234
self.fingerprint = fingerprint.upper().replace(u" ", u"")
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
self.secret = secret.decode(u"base64")
240
self.secret = sf.read()
513
if server_settings is None:
515
self.server_settings = server_settings
516
# adding all client settings
517
for setting, value in settings.items():
518
setattr(self, setting, value)
521
if not hasattr(self, "last_enabled"):
522
self.last_enabled = datetime.datetime.utcnow()
523
if not hasattr(self, "expires"):
524
self.expires = (datetime.datetime.utcnow()
243
raise TypeError(u"No secret or secfile for client %s"
246
self.created = datetime.datetime.now()
247
self.last_checked_ok = None
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
250
self.stop_hook = stop_hook
527
self.last_enabled = None
530
logger.debug("Creating client %r", self.name)
531
# Uppercase and remove spaces from fingerprint for later
532
# comparison purposes with return value from the fingerprint()
534
logger.debug(" Fingerprint: %s", self.fingerprint)
535
self.created = settings.get("created",
536
datetime.datetime.utcnow())
538
# attributes specific for this server instance
251
539
self.checker = None
252
540
self.checker_initiator_tag = None
253
self.stop_initiator_tag = None
541
self.disable_initiator_tag = None
254
542
self.checker_callback_tag = None
255
self.check_command = checker
543
self.current_checker_command = None
545
self.approvals_pending = 0
546
self.changedstate = (multiprocessing_manager
547
.Condition(multiprocessing_manager
549
self.client_structure = [attr for attr in
550
self.__dict__.iterkeys()
551
if not attr.startswith("_")]
552
self.client_structure.append("client_structure")
554
for name, t in inspect.getmembers(type(self),
558
if not name.startswith("_"):
559
self.client_structure.append(name)
561
# Send notice to process children that client state has changed
562
def send_changedstate(self):
563
with self.changedstate:
564
self.changedstate.notify_all()
257
567
"""Start this client's checker and timeout hooks"""
568
if getattr(self, "enabled", False):
571
self.expires = datetime.datetime.utcnow() + self.timeout
573
self.last_enabled = datetime.datetime.utcnow()
575
self.send_changedstate()
577
def disable(self, quiet=True):
578
"""Disable this client."""
579
if not getattr(self, "enabled", False):
582
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", None) is not None:
584
gobject.source_remove(self.disable_initiator_tag)
585
self.disable_initiator_tag = None
587
if getattr(self, "checker_initiator_tag", None) is not None:
588
gobject.source_remove(self.checker_initiator_tag)
589
self.checker_initiator_tag = None
593
self.send_changedstate()
594
# Do not run this again if called by a gobject.timeout_add
600
def init_checker(self):
258
601
# Schedule a new checker to be started an 'interval' from now,
259
602
# and every interval from then on.
260
self.checker_initiator_tag = gobject.timeout_add\
261
(self._interval_milliseconds,
603
if self.checker_initiator_tag is not None:
604
gobject.source_remove(self.checker_initiator_tag)
605
self.checker_initiator_tag = (gobject.timeout_add
607
.total_seconds() * 1000),
609
# Schedule a disable() when 'timeout' has passed
610
if self.disable_initiator_tag is not None:
611
gobject.source_remove(self.disable_initiator_tag)
612
self.disable_initiator_tag = (gobject.timeout_add
614
.total_seconds() * 1000),
263
616
# Also start a new checker *right now*.
264
617
self.start_checker()
265
# Schedule a stop() when 'timeout' has passed
266
self.stop_initiator_tag = gobject.timeout_add\
267
(self._timeout_milliseconds,
271
The possibility that a client might be restarted is left open,
272
but not currently used."""
273
# If this client doesn't have a secret, it is already stopped.
275
logger.debug(u"Stopping client %s", self.name)
279
if getattr(self, "stop_initiator_tag", False):
280
gobject.source_remove(self.stop_initiator_tag)
281
self.stop_initiator_tag = None
282
if getattr(self, "checker_initiator_tag", False):
283
gobject.source_remove(self.checker_initiator_tag)
284
self.checker_initiator_tag = None
288
# Do not run this again if called by a gobject.timeout_add
291
self.stop_hook = None
293
def checker_callback(self, pid, condition):
619
def checker_callback(self, pid, condition, command):
294
620
"""The checker has completed, so take appropriate actions."""
295
now = datetime.datetime.now()
296
621
self.checker_callback_tag = None
297
622
self.checker = None
298
if os.WIFEXITED(condition) \
299
and (os.WEXITSTATUS(condition) == 0):
300
logger.debug(u"Checker for %(name)s succeeded",
302
self.last_checked_ok = now
303
gobject.source_remove(self.stop_initiator_tag)
304
self.stop_initiator_tag = gobject.timeout_add\
305
(self._timeout_milliseconds,
307
elif not os.WIFEXITED(condition):
308
logger.warning(u"Checker for %(name)s crashed?",
623
if os.WIFEXITED(condition):
624
self.last_checker_status = os.WEXITSTATUS(condition)
625
if self.last_checker_status == 0:
626
logger.info("Checker for %(name)s succeeded",
630
logger.info("Checker for %(name)s failed",
633
self.last_checker_status = -1
634
logger.warning("Checker for %(name)s crashed?",
311
logger.debug(u"Checker for %(name)s failed",
637
def checked_ok(self):
638
"""Assert that the client has been seen, alive and well."""
639
self.last_checked_ok = datetime.datetime.utcnow()
640
self.last_checker_status = 0
643
def bump_timeout(self, timeout=None):
644
"""Bump up the timeout for this client."""
646
timeout = self.timeout
647
if self.disable_initiator_tag is not None:
648
gobject.source_remove(self.disable_initiator_tag)
649
self.disable_initiator_tag = None
650
if getattr(self, "enabled", False):
651
self.disable_initiator_tag = (gobject.timeout_add
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
654
self.expires = datetime.datetime.utcnow() + timeout
656
def need_approval(self):
657
self.last_approval_request = datetime.datetime.utcnow()
313
659
def start_checker(self):
314
660
"""Start a new checker subprocess if one is not running.
315
662
If a checker already exists, leave it running and do
317
664
# The reason for not killing a running checker is that if we
318
# did that, then if a checker (for some reason) started
319
# running slowly and taking more than 'interval' time, the
320
# client would inevitably timeout, since no checker would get
321
# a chance to run to completion. If we instead leave running
665
# did that, and if a checker (for some reason) started running
666
# slowly and taking more than 'interval' time, then the client
667
# would inevitably timeout, since no checker would get a
668
# chance to run to completion. If we instead leave running
322
669
# checkers alone, the checker would have to take more time
323
# than 'timeout' for the client to be declared invalid, which
324
# is as it should be.
670
# than 'timeout' for the client to be disabled, which is as it
673
# If a checker exists, make sure it is not a zombie
675
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
676
except AttributeError:
678
except OSError as error:
679
if error.errno != errno.ECHILD:
683
logger.warning("Checker was a zombie")
684
gobject.source_remove(self.checker_callback_tag)
685
self.checker_callback(pid, status,
686
self.current_checker_command)
687
# Start a new checker if needed
325
688
if self.checker is None:
327
# In case check_command has exactly one % operator
328
command = self.check_command % self.fqdn
330
# Escape attributes for the shell
331
escaped_attrs = dict((key, re.escape(str(val)))
333
vars(self).iteritems())
335
command = self.check_command % escaped_attrs
336
except TypeError, error:
337
logger.error(u'Could not format string "%s":'
338
u' %s', self.check_command, error)
339
return True # Try again later
341
logger.debug(u"Starting checker %r for %s",
689
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(str(getattr(self, attr)))
692
for attr in self.runtime_expansions }
694
command = self.checker_command % escaped_attrs
695
except TypeError as error:
696
logger.error('Could not format string "%s"',
697
self.checker_command, exc_info=error)
698
return True # Try again later
699
self.current_checker_command = command
701
logger.info("Starting checker %r for %s",
703
# We don't need to redirect stdout and stderr, since
704
# in normal mode, that is already done by daemon(),
705
# and in debug mode we don't want to. (Stdin is
706
# always replaced by /dev/null.)
707
# The exception is when not debugging but nevertheless
708
# running in the foreground; use the previously
711
if (not self.server_settings["debug"]
712
and self.server_settings["foreground"]):
713
popen_args.update({"stdout": wnull,
343
715
self.checker = subprocess.Popen(command,
346
self.checker_callback_tag = gobject.child_watch_add\
348
self.checker_callback)
349
except subprocess.OSError, error:
350
logger.error(u"Failed to start subprocess: %s",
719
except OSError as error:
720
logger.error("Failed to start subprocess",
723
self.checker_callback_tag = (gobject.child_watch_add
725
self.checker_callback,
727
# The checker may have completed before the gobject
728
# watch was added. Check for this.
730
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
731
except OSError as error:
732
if error.errno == errno.ECHILD:
733
# This should never happen
734
logger.error("Child process vanished",
739
gobject.source_remove(self.checker_callback_tag)
740
self.checker_callback(pid, status, command)
352
741
# Re-run this periodically if run by gobject.timeout_add
354
744
def stop_checker(self):
355
745
"""Force the checker process, if any, to stop."""
356
746
if self.checker_callback_tag:
361
751
logger.debug("Stopping checker for %(name)s", vars(self))
363
os.kill(self.checker.pid, signal.SIGTERM)
753
self.checker.terminate()
365
755
#if self.checker.poll() is None:
366
# os.kill(self.checker.pid, signal.SIGKILL)
367
except OSError, error:
756
# self.checker.kill()
757
except OSError as error:
368
758
if error.errno != errno.ESRCH: # No such process
370
760
self.checker = None
371
def still_valid(self):
372
"""Has the timeout not yet passed for this client?"""
373
now = datetime.datetime.now()
374
if self.last_checked_ok is None:
375
return now < (self.created + self.timeout)
377
return now < (self.last_checked_ok + self.timeout)
380
def peer_certificate(session):
381
"Return the peer's OpenPGP certificate as a bytestring"
382
# If not an OpenPGP certificate...
383
if gnutls.library.functions.gnutls_certificate_type_get\
384
(session._c_object) \
385
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
386
# ...do the normal thing
387
return session.peer_certificate
388
list_size = ctypes.c_uint()
389
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
390
(session._c_object, ctypes.byref(list_size))
391
if list_size.value == 0:
394
return ctypes.string_at(cert.data, cert.size)
397
def fingerprint(openpgp):
398
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
399
# New empty GnuTLS certificate
400
crt = gnutls.library.types.gnutls_openpgp_crt_t()
401
gnutls.library.functions.gnutls_openpgp_crt_init\
403
# New GnuTLS "datum" with the OpenPGP public key
404
datum = gnutls.library.types.gnutls_datum_t\
405
(ctypes.cast(ctypes.c_char_p(openpgp),
406
ctypes.POINTER(ctypes.c_ubyte)),
407
ctypes.c_uint(len(openpgp)))
408
# Import the OpenPGP public key into the certificate
409
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
412
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
# New buffer for the fingerprint
414
buffer = ctypes.create_string_buffer(20)
415
buffer_length = ctypes.c_size_t()
416
# Get the fingerprint from the certificate into the buffer
417
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
418
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
419
# Deinit the certificate
420
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
421
# Convert the buffer to a Python bytestring
422
fpr = ctypes.string_at(buffer, buffer_length.value)
423
# Convert the bytestring to hexadecimal notation
424
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
429
"""A TCP request handler class.
430
Instantiated by IPv6_TCPServer for each request to handle it.
763
def dbus_service_property(dbus_interface, signature="v",
764
access="readwrite", byte_arrays=False):
765
"""Decorators for marking methods of a DBusObjectWithProperties to
766
become properties on the D-Bus.
768
The decorated method will be called with no arguments by "Get"
769
and with one argument by "Set".
771
The parameters, where they are supported, are the same as
772
dbus.service.method, except there is only "signature", since the
773
type from Get() and the type sent to Set() is the same.
775
# Encoding deeply encoded byte arrays is not supported yet by the
776
# "Set" method, so we fail early here:
777
if byte_arrays and signature != "ay":
778
raise ValueError("Byte arrays not supported for non-'ay'"
779
" signature {!r}".format(signature))
781
func._dbus_is_property = True
782
func._dbus_interface = dbus_interface
783
func._dbus_signature = signature
784
func._dbus_access = access
785
func._dbus_name = func.__name__
786
if func._dbus_name.endswith("_dbus_property"):
787
func._dbus_name = func._dbus_name[:-14]
788
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
793
def dbus_interface_annotations(dbus_interface):
794
"""Decorator for marking functions returning interface annotations
798
@dbus_interface_annotations("org.example.Interface")
799
def _foo(self): # Function name does not matter
800
return {"org.freedesktop.DBus.Deprecated": "true",
801
"org.freedesktop.DBus.Property.EmitsChangedSignal":
805
func._dbus_is_interface = True
806
func._dbus_interface = dbus_interface
807
func._dbus_name = dbus_interface
812
def dbus_annotations(annotations):
813
"""Decorator to annotate D-Bus methods, signals or properties
816
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
817
"org.freedesktop.DBus.Property."
818
"EmitsChangedSignal": "false"})
819
@dbus_service_property("org.example.Interface", signature="b",
821
def Property_dbus_property(self):
822
return dbus.Boolean(False)
825
func._dbus_annotations = annotations
830
class DBusPropertyException(dbus.exceptions.DBusException):
831
"""A base class for D-Bus property-related exceptions
835
class DBusPropertyAccessException(DBusPropertyException):
836
"""A property's access permissions disallows an operation.
841
class DBusPropertyNotFound(DBusPropertyException):
842
"""An attempt was made to access a non-existing property.
847
class DBusObjectWithProperties(dbus.service.Object):
848
"""A D-Bus object with properties.
850
Classes inheriting from this can use the dbus_service_property
851
decorator to expose methods as D-Bus properties. It exposes the
852
standard Get(), Set(), and GetAll() methods on the D-Bus.
856
def _is_dbus_thing(thing):
857
"""Returns a function testing if an attribute is a D-Bus thing
859
If called like _is_dbus_thing("method") it returns a function
860
suitable for use as predicate to inspect.getmembers().
862
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
865
def _get_all_dbus_things(self, thing):
866
"""Returns a generator of (name, attribute) pairs
868
return ((getattr(athing.__get__(self), "_dbus_name",
870
athing.__get__(self))
871
for cls in self.__class__.__mro__
873
inspect.getmembers(cls,
874
self._is_dbus_thing(thing)))
876
def _get_dbus_property(self, interface_name, property_name):
877
"""Returns a bound method if one exists which is a D-Bus
878
property with the specified name and interface.
880
for cls in self.__class__.__mro__:
881
for name, value in (inspect.getmembers
883
self._is_dbus_thing("property"))):
884
if (value._dbus_name == property_name
885
and value._dbus_interface == interface_name):
886
return value.__get__(self)
889
raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
+ interface_name + "."
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
895
def Get(self, interface_name, property_name):
896
"""Standard D-Bus property Get() method, see D-Bus standard.
898
prop = self._get_dbus_property(interface_name, property_name)
899
if prop._dbus_access == "write":
900
raise DBusPropertyAccessException(property_name)
902
if not hasattr(value, "variant_level"):
904
return type(value)(value, variant_level=value.variant_level+1)
906
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
907
def Set(self, interface_name, property_name, value):
908
"""Standard D-Bus property Set() method, see D-Bus standard.
910
prop = self._get_dbus_property(interface_name, property_name)
911
if prop._dbus_access == "read":
912
raise DBusPropertyAccessException(property_name)
913
if prop._dbus_get_args_options["byte_arrays"]:
914
# The byte_arrays option is not supported yet on
915
# signatures other than "ay".
916
if prop._dbus_signature != "ay":
917
raise ValueError("Byte arrays not supported for non-"
918
"'ay' signature {!r}"
919
.format(prop._dbus_signature))
920
value = dbus.ByteArray(b''.join(chr(byte)
924
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
925
out_signature="a{sv}")
926
def GetAll(self, interface_name):
927
"""Standard D-Bus property GetAll() method, see D-Bus
930
Note: Will not include properties with access="write".
933
for name, prop in self._get_all_dbus_things("property"):
935
and interface_name != prop._dbus_interface):
936
# Interface non-empty but did not match
938
# Ignore write-only properties
939
if prop._dbus_access == "write":
942
if not hasattr(value, "variant_level"):
943
properties[name] = value
945
properties[name] = type(value)(value, variant_level=
946
value.variant_level+1)
947
return dbus.Dictionary(properties, signature="sv")
949
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
950
def PropertiesChanged(self, interface_name, changed_properties,
951
invalidated_properties):
952
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
957
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
959
path_keyword='object_path',
960
connection_keyword='connection')
961
def Introspect(self, object_path, connection):
962
"""Overloading of standard D-Bus method.
964
Inserts property tags and interface annotation tags.
966
xmlstring = dbus.service.Object.Introspect(self, object_path,
969
document = xml.dom.minidom.parseString(xmlstring)
970
def make_tag(document, name, prop):
971
e = document.createElement("property")
972
e.setAttribute("name", name)
973
e.setAttribute("type", prop._dbus_signature)
974
e.setAttribute("access", prop._dbus_access)
976
for if_tag in document.getElementsByTagName("interface"):
978
for tag in (make_tag(document, name, prop)
980
in self._get_all_dbus_things("property")
981
if prop._dbus_interface
982
== if_tag.getAttribute("name")):
983
if_tag.appendChild(tag)
984
# Add annotation tags
985
for typ in ("method", "signal", "property"):
986
for tag in if_tag.getElementsByTagName(typ):
988
for name, prop in (self.
989
_get_all_dbus_things(typ)):
990
if (name == tag.getAttribute("name")
991
and prop._dbus_interface
992
== if_tag.getAttribute("name")):
993
annots.update(getattr
997
for name, value in annots.items():
998
ann_tag = document.createElement(
1000
ann_tag.setAttribute("name", name)
1001
ann_tag.setAttribute("value", value)
1002
tag.appendChild(ann_tag)
1003
# Add interface annotation tags
1004
for annotation, value in dict(
1005
itertools.chain.from_iterable(
1006
annotations().items()
1007
for name, annotations in
1008
self._get_all_dbus_things("interface")
1009
if name == if_tag.getAttribute("name")
1011
ann_tag = document.createElement("annotation")
1012
ann_tag.setAttribute("name", annotation)
1013
ann_tag.setAttribute("value", value)
1014
if_tag.appendChild(ann_tag)
1015
# Add the names to the return values for the
1016
# "org.freedesktop.DBus.Properties" methods
1017
if (if_tag.getAttribute("name")
1018
== "org.freedesktop.DBus.Properties"):
1019
for cn in if_tag.getElementsByTagName("method"):
1020
if cn.getAttribute("name") == "Get":
1021
for arg in cn.getElementsByTagName("arg"):
1022
if (arg.getAttribute("direction")
1024
arg.setAttribute("name", "value")
1025
elif cn.getAttribute("name") == "GetAll":
1026
for arg in cn.getElementsByTagName("arg"):
1027
if (arg.getAttribute("direction")
1029
arg.setAttribute("name", "props")
1030
xmlstring = document.toxml("utf-8")
1032
except (AttributeError, xml.dom.DOMException,
1033
xml.parsers.expat.ExpatError) as error:
1034
logger.error("Failed to override Introspection method",
1039
def datetime_to_dbus(dt, variant_level=0):
1040
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1042
return dbus.String("", variant_level = variant_level)
1043
return dbus.String(dt.isoformat(),
1044
variant_level=variant_level)
1047
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1048
"""A class decorator; applied to a subclass of
1049
dbus.service.Object, it will add alternate D-Bus attributes with
1050
interface names according to the "alt_interface_names" mapping.
1053
@alternate_dbus_interfaces({"org.example.Interface":
1054
"net.example.AlternateInterface"})
1055
class SampleDBusObject(dbus.service.Object):
1056
@dbus.service.method("org.example.Interface")
1057
def SampleDBusMethod():
1060
The above "SampleDBusMethod" on "SampleDBusObject" will be
1061
reachable via two interfaces: "org.example.Interface" and
1062
"net.example.AlternateInterface", the latter of which will have
1063
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1064
"true", unless "deprecate" is passed with a False value.
1066
This works for methods and signals, and also for D-Bus properties
1067
(from DBusObjectWithProperties) and interfaces (from the
1068
dbus_interface_annotations decorator).
1071
for orig_interface_name, alt_interface_name in (
1072
alt_interface_names.items()):
1074
interface_names = set()
1075
# Go though all attributes of the class
1076
for attrname, attribute in inspect.getmembers(cls):
1077
# Ignore non-D-Bus attributes, and D-Bus attributes
1078
# with the wrong interface name
1079
if (not hasattr(attribute, "_dbus_interface")
1080
or not attribute._dbus_interface
1081
.startswith(orig_interface_name)):
1083
# Create an alternate D-Bus interface name based on
1085
alt_interface = (attribute._dbus_interface
1086
.replace(orig_interface_name,
1087
alt_interface_name))
1088
interface_names.add(alt_interface)
1089
# Is this a D-Bus signal?
1090
if getattr(attribute, "_dbus_is_signal", False):
1091
# Extract the original non-method undecorated
1092
# function by black magic
1093
nonmethod_func = (dict(
1094
zip(attribute.func_code.co_freevars,
1095
attribute.__closure__))["func"]
1097
# Create a new, but exactly alike, function
1098
# object, and decorate it to be a new D-Bus signal
1099
# with the alternate D-Bus interface name
1100
new_function = (dbus.service.signal
1102
attribute._dbus_signature)
1103
(types.FunctionType(
1104
nonmethod_func.func_code,
1105
nonmethod_func.func_globals,
1106
nonmethod_func.func_name,
1107
nonmethod_func.func_defaults,
1108
nonmethod_func.func_closure)))
1109
# Copy annotations, if any
1111
new_function._dbus_annotations = (
1112
dict(attribute._dbus_annotations))
1113
except AttributeError:
1115
# Define a creator of a function to call both the
1116
# original and alternate functions, so both the
1117
# original and alternate signals gets sent when
1118
# the function is called
1119
def fixscope(func1, func2):
1120
"""This function is a scope container to pass
1121
func1 and func2 to the "call_both" function
1122
outside of its arguments"""
1123
def call_both(*args, **kwargs):
1124
"""This function will emit two D-Bus
1125
signals by calling func1 and func2"""
1126
func1(*args, **kwargs)
1127
func2(*args, **kwargs)
1129
# Create the "call_both" function and add it to
1131
attr[attrname] = fixscope(attribute, new_function)
1132
# Is this a D-Bus method?
1133
elif getattr(attribute, "_dbus_is_method", False):
1134
# Create a new, but exactly alike, function
1135
# object. Decorate it to be a new D-Bus method
1136
# with the alternate D-Bus interface name. Add it
1138
attr[attrname] = (dbus.service.method
1140
attribute._dbus_in_signature,
1141
attribute._dbus_out_signature)
1143
(attribute.func_code,
1144
attribute.func_globals,
1145
attribute.func_name,
1146
attribute.func_defaults,
1147
attribute.func_closure)))
1148
# Copy annotations, if any
1150
attr[attrname]._dbus_annotations = (
1151
dict(attribute._dbus_annotations))
1152
except AttributeError:
1154
# Is this a D-Bus property?
1155
elif getattr(attribute, "_dbus_is_property", False):
1156
# Create a new, but exactly alike, function
1157
# object, and decorate it to be a new D-Bus
1158
# property with the alternate D-Bus interface
1159
# name. Add it to the class.
1160
attr[attrname] = (dbus_service_property
1162
attribute._dbus_signature,
1163
attribute._dbus_access,
1165
._dbus_get_args_options
1168
(attribute.func_code,
1169
attribute.func_globals,
1170
attribute.func_name,
1171
attribute.func_defaults,
1172
attribute.func_closure)))
1173
# Copy annotations, if any
1175
attr[attrname]._dbus_annotations = (
1176
dict(attribute._dbus_annotations))
1177
except AttributeError:
1179
# Is this a D-Bus interface?
1180
elif getattr(attribute, "_dbus_is_interface", False):
1181
# Create a new, but exactly alike, function
1182
# object. Decorate it to be a new D-Bus interface
1183
# with the alternate D-Bus interface name. Add it
1185
attr[attrname] = (dbus_interface_annotations
1188
(attribute.func_code,
1189
attribute.func_globals,
1190
attribute.func_name,
1191
attribute.func_defaults,
1192
attribute.func_closure)))
1194
# Deprecate all alternate interfaces
1195
iname="_AlternateDBusNames_interface_annotation{}"
1196
for interface_name in interface_names:
1197
@dbus_interface_annotations(interface_name)
1199
return { "org.freedesktop.DBus.Deprecated":
1201
# Find an unused name
1202
for aname in (iname.format(i)
1203
for i in itertools.count()):
1204
if aname not in attr:
1208
# Replace the class with a new subclass of it with
1209
# methods, signals, etc. as created above.
1210
cls = type(b"{}Alternate".format(cls.__name__),
1216
@alternate_dbus_interfaces({"se.recompile.Mandos":
1217
"se.bsnet.fukt.Mandos"})
1218
class ClientDBus(Client, DBusObjectWithProperties):
1219
"""A Client class using D-Bus
1222
dbus_object_path: dbus.ObjectPath
1223
bus: dbus.SystemBus()
1226
runtime_expansions = (Client.runtime_expansions
1227
+ ("dbus_object_path",))
1229
_interface = "se.recompile.Mandos.Client"
1231
# dbus.service.Object doesn't use super(), so we can't either.
1233
def __init__(self, bus = None, *args, **kwargs):
1235
Client.__init__(self, *args, **kwargs)
1236
# Only now, when this client is initialized, can it show up on
1238
client_object_name = str(self.name).translate(
1239
{ord("."): ord("_"),
1240
ord("-"): ord("_")})
1241
self.dbus_object_path = (dbus.ObjectPath
1242
("/clients/" + client_object_name))
1243
DBusObjectWithProperties.__init__(self, self.bus,
1244
self.dbus_object_path)
1246
def notifychangeproperty(transform_func,
1247
dbus_name, type_func=lambda x: x,
1248
variant_level=1, invalidate_only=False,
1249
_interface=_interface):
1250
""" Modify a variable so that it's a property which announces
1251
its changes to DBus.
1253
transform_fun: Function that takes a value and a variant_level
1254
and transforms it to a D-Bus type.
1255
dbus_name: D-Bus name of the variable
1256
type_func: Function that transform the value before sending it
1257
to the D-Bus. Default: no transform
1258
variant_level: D-Bus variant level. Default: 1
1260
attrname = "_{}".format(dbus_name)
1261
def setter(self, value):
1262
if hasattr(self, "dbus_object_path"):
1263
if (not hasattr(self, attrname) or
1264
type_func(getattr(self, attrname, None))
1265
!= type_func(value)):
1267
self.PropertiesChanged(_interface,
1272
dbus_value = transform_func(type_func(value),
1275
self.PropertyChanged(dbus.String(dbus_name),
1277
self.PropertiesChanged(_interface,
1279
dbus.String(dbus_name):
1280
dbus_value }), dbus.Array())
1281
setattr(self, attrname, value)
1283
return property(lambda self: getattr(self, attrname), setter)
1285
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1286
approvals_pending = notifychangeproperty(dbus.Boolean,
1289
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1290
last_enabled = notifychangeproperty(datetime_to_dbus,
1292
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1293
type_func = lambda checker:
1294
checker is not None)
1295
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1297
last_checker_status = notifychangeproperty(dbus.Int16,
1298
"LastCheckerStatus")
1299
last_approval_request = notifychangeproperty(
1300
datetime_to_dbus, "LastApprovalRequest")
1301
approved_by_default = notifychangeproperty(dbus.Boolean,
1302
"ApprovedByDefault")
1303
approval_delay = notifychangeproperty(dbus.UInt64,
1306
lambda td: td.total_seconds()
1308
approval_duration = notifychangeproperty(
1309
dbus.UInt64, "ApprovalDuration",
1310
type_func = lambda td: td.total_seconds() * 1000)
1311
host = notifychangeproperty(dbus.String, "Host")
1312
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1313
type_func = lambda td:
1314
td.total_seconds() * 1000)
1315
extended_timeout = notifychangeproperty(
1316
dbus.UInt64, "ExtendedTimeout",
1317
type_func = lambda td: td.total_seconds() * 1000)
1318
interval = notifychangeproperty(dbus.UInt64,
1321
lambda td: td.total_seconds()
1323
checker_command = notifychangeproperty(dbus.String, "Checker")
1324
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1325
invalidate_only=True)
1327
del notifychangeproperty
1329
def __del__(self, *args, **kwargs):
1331
self.remove_from_connection()
1334
if hasattr(DBusObjectWithProperties, "__del__"):
1335
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1336
Client.__del__(self, *args, **kwargs)
1338
def checker_callback(self, pid, condition, command,
1340
self.checker_callback_tag = None
1342
if os.WIFEXITED(condition):
1343
exitstatus = os.WEXITSTATUS(condition)
1345
self.CheckerCompleted(dbus.Int16(exitstatus),
1346
dbus.Int64(condition),
1347
dbus.String(command))
1350
self.CheckerCompleted(dbus.Int16(-1),
1351
dbus.Int64(condition),
1352
dbus.String(command))
1354
return Client.checker_callback(self, pid, condition, command,
1357
def start_checker(self, *args, **kwargs):
1358
old_checker_pid = getattr(self.checker, "pid", None)
1359
r = Client.start_checker(self, *args, **kwargs)
1360
# Only if new checker process was started
1361
if (self.checker is not None
1362
and old_checker_pid != self.checker.pid):
1364
self.CheckerStarted(self.current_checker_command)
1367
def _reset_approved(self):
1368
self.approved = None
1371
def approve(self, value=True):
1372
self.approved = value
1373
gobject.timeout_add(int(self.approval_duration.total_seconds()
1374
* 1000), self._reset_approved)
1375
self.send_changedstate()
1377
## D-Bus methods, signals & properties
1383
# CheckerCompleted - signal
1384
@dbus.service.signal(_interface, signature="nxs")
1385
def CheckerCompleted(self, exitcode, waitstatus, command):
1389
# CheckerStarted - signal
1390
@dbus.service.signal(_interface, signature="s")
1391
def CheckerStarted(self, command):
1395
# PropertyChanged - signal
1396
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1397
@dbus.service.signal(_interface, signature="sv")
1398
def PropertyChanged(self, property, value):
1402
# GotSecret - signal
1403
@dbus.service.signal(_interface)
1404
def GotSecret(self):
1406
Is sent after a successful transfer of secret from the Mandos
1407
server to mandos-client
1412
@dbus.service.signal(_interface, signature="s")
1413
def Rejected(self, reason):
1417
# NeedApproval - signal
1418
@dbus.service.signal(_interface, signature="tb")
1419
def NeedApproval(self, timeout, default):
1421
return self.need_approval()
1426
@dbus.service.method(_interface, in_signature="b")
1427
def Approve(self, value):
1430
# CheckedOK - method
1431
@dbus.service.method(_interface)
1432
def CheckedOK(self):
1436
@dbus.service.method(_interface)
1441
# StartChecker - method
1442
@dbus.service.method(_interface)
1443
def StartChecker(self):
1445
self.start_checker()
1448
@dbus.service.method(_interface)
1453
# StopChecker - method
1454
@dbus.service.method(_interface)
1455
def StopChecker(self):
1460
# ApprovalPending - property
1461
@dbus_service_property(_interface, signature="b", access="read")
1462
def ApprovalPending_dbus_property(self):
1463
return dbus.Boolean(bool(self.approvals_pending))
1465
# ApprovedByDefault - property
1466
@dbus_service_property(_interface, signature="b",
1468
def ApprovedByDefault_dbus_property(self, value=None):
1469
if value is None: # get
1470
return dbus.Boolean(self.approved_by_default)
1471
self.approved_by_default = bool(value)
1473
# ApprovalDelay - property
1474
@dbus_service_property(_interface, signature="t",
1476
def ApprovalDelay_dbus_property(self, value=None):
1477
if value is None: # get
1478
return dbus.UInt64(self.approval_delay.total_seconds()
1480
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1482
# ApprovalDuration - property
1483
@dbus_service_property(_interface, signature="t",
1485
def ApprovalDuration_dbus_property(self, value=None):
1486
if value is None: # get
1487
return dbus.UInt64(self.approval_duration.total_seconds()
1489
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1492
@dbus_service_property(_interface, signature="s", access="read")
1493
def Name_dbus_property(self):
1494
return dbus.String(self.name)
1496
# Fingerprint - property
1497
@dbus_service_property(_interface, signature="s", access="read")
1498
def Fingerprint_dbus_property(self):
1499
return dbus.String(self.fingerprint)
1502
@dbus_service_property(_interface, signature="s",
1504
def Host_dbus_property(self, value=None):
1505
if value is None: # get
1506
return dbus.String(self.host)
1507
self.host = str(value)
1509
# Created - property
1510
@dbus_service_property(_interface, signature="s", access="read")
1511
def Created_dbus_property(self):
1512
return datetime_to_dbus(self.created)
1514
# LastEnabled - property
1515
@dbus_service_property(_interface, signature="s", access="read")
1516
def LastEnabled_dbus_property(self):
1517
return datetime_to_dbus(self.last_enabled)
1519
# Enabled - property
1520
@dbus_service_property(_interface, signature="b",
1522
def Enabled_dbus_property(self, value=None):
1523
if value is None: # get
1524
return dbus.Boolean(self.enabled)
1530
# LastCheckedOK - property
1531
@dbus_service_property(_interface, signature="s",
1533
def LastCheckedOK_dbus_property(self, value=None):
1534
if value is not None:
1537
return datetime_to_dbus(self.last_checked_ok)
1539
# LastCheckerStatus - property
1540
@dbus_service_property(_interface, signature="n",
1542
def LastCheckerStatus_dbus_property(self):
1543
return dbus.Int16(self.last_checker_status)
1545
# Expires - property
1546
@dbus_service_property(_interface, signature="s", access="read")
1547
def Expires_dbus_property(self):
1548
return datetime_to_dbus(self.expires)
1550
# LastApprovalRequest - property
1551
@dbus_service_property(_interface, signature="s", access="read")
1552
def LastApprovalRequest_dbus_property(self):
1553
return datetime_to_dbus(self.last_approval_request)
1555
# Timeout - property
1556
@dbus_service_property(_interface, signature="t",
1558
def Timeout_dbus_property(self, value=None):
1559
if value is None: # get
1560
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1561
old_timeout = self.timeout
1562
self.timeout = datetime.timedelta(0, 0, 0, value)
1563
# Reschedule disabling
1565
now = datetime.datetime.utcnow()
1566
self.expires += self.timeout - old_timeout
1567
if self.expires <= now:
1568
# The timeout has passed
1571
if (getattr(self, "disable_initiator_tag", None)
1574
gobject.source_remove(self.disable_initiator_tag)
1575
self.disable_initiator_tag = (
1576
gobject.timeout_add(
1577
int((self.expires - now).total_seconds()
1578
* 1000), self.disable))
1580
# ExtendedTimeout - property
1581
@dbus_service_property(_interface, signature="t",
1583
def ExtendedTimeout_dbus_property(self, value=None):
1584
if value is None: # get
1585
return dbus.UInt64(self.extended_timeout.total_seconds()
1587
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1589
# Interval - property
1590
@dbus_service_property(_interface, signature="t",
1592
def Interval_dbus_property(self, value=None):
1593
if value is None: # get
1594
return dbus.UInt64(self.interval.total_seconds() * 1000)
1595
self.interval = datetime.timedelta(0, 0, 0, value)
1596
if getattr(self, "checker_initiator_tag", None) is None:
1599
# Reschedule checker run
1600
gobject.source_remove(self.checker_initiator_tag)
1601
self.checker_initiator_tag = (gobject.timeout_add
1602
(value, self.start_checker))
1603
self.start_checker() # Start one now, too
1605
# Checker - property
1606
@dbus_service_property(_interface, signature="s",
1608
def Checker_dbus_property(self, value=None):
1609
if value is None: # get
1610
return dbus.String(self.checker_command)
1611
self.checker_command = str(value)
1613
# CheckerRunning - property
1614
@dbus_service_property(_interface, signature="b",
1616
def CheckerRunning_dbus_property(self, value=None):
1617
if value is None: # get
1618
return dbus.Boolean(self.checker is not None)
1620
self.start_checker()
1624
# ObjectPath - property
1625
@dbus_service_property(_interface, signature="o", access="read")
1626
def ObjectPath_dbus_property(self):
1627
return self.dbus_object_path # is already a dbus.ObjectPath
1630
@dbus_service_property(_interface, signature="ay",
1631
access="write", byte_arrays=True)
1632
def Secret_dbus_property(self, value):
1633
self.secret = bytes(value)
1638
class ProxyClient(object):
1639
def __init__(self, child_pipe, fpr, address):
1640
self._pipe = child_pipe
1641
self._pipe.send(('init', fpr, address))
1642
if not self._pipe.recv():
1645
def __getattribute__(self, name):
1647
return super(ProxyClient, self).__getattribute__(name)
1648
self._pipe.send(('getattr', name))
1649
data = self._pipe.recv()
1650
if data[0] == 'data':
1652
if data[0] == 'function':
1653
def func(*args, **kwargs):
1654
self._pipe.send(('funcall', name, args, kwargs))
1655
return self._pipe.recv()[1]
1658
def __setattr__(self, name, value):
1660
return super(ProxyClient, self).__setattr__(name, value)
1661
self._pipe.send(('setattr', name, value))
1664
class ClientHandler(socketserver.BaseRequestHandler, object):
1665
"""A class to handle client connections.
1667
Instantiated once for each connection to handle it.
431
1668
Note: This will run in its own forked process."""
433
1670
def handle(self):
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
436
session = gnutls.connection.ClientSession\
437
(self.request, gnutls.connection.X509Credentials())
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.debug(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.debug(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.debug(u"Client not found for fingerprint: %s", fpr)
476
# Have to check if client.still_valid(), since it is possible
477
# that the client timed out while establishing the GnuTLS
479
if not client.still_valid():
480
logger.debug(u"Client %(name)s is invalid", vars(client))
484
while sent_size < len(client.secret):
485
sent = session.send(client.secret[sent_size:])
486
logger.debug(u"Sent: %d, remaining: %d",
487
sent, len(client.secret)
488
- (sent_size + sent))
493
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
494
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1671
with contextlib.closing(self.server.child_pipe) as child_pipe:
1672
logger.info("TCP connection from: %s",
1673
str(self.client_address))
1674
logger.debug("Pipe FD: %d",
1675
self.server.child_pipe.fileno())
1677
session = (gnutls.connection
1678
.ClientSession(self.request,
1680
.X509Credentials()))
1682
# Note: gnutls.connection.X509Credentials is really a
1683
# generic GnuTLS certificate credentials object so long as
1684
# no X.509 keys are added to it. Therefore, we can use it
1685
# here despite using OpenPGP certificates.
1687
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1688
# "+AES-256-CBC", "+SHA1",
1689
# "+COMP-NULL", "+CTYPE-OPENPGP",
1691
# Use a fallback default, since this MUST be set.
1692
priority = self.server.gnutls_priority
1693
if priority is None:
1695
(gnutls.library.functions
1696
.gnutls_priority_set_direct(session._c_object,
1699
# Start communication using the Mandos protocol
1700
# Get protocol number
1701
line = self.request.makefile().readline()
1702
logger.debug("Protocol version: %r", line)
1704
if int(line.strip().split()[0]) > 1:
1705
raise RuntimeError(line)
1706
except (ValueError, IndexError, RuntimeError) as error:
1707
logger.error("Unknown protocol version: %s", error)
1710
# Start GnuTLS connection
1713
except gnutls.errors.GNUTLSError as error:
1714
logger.warning("Handshake failed: %s", error)
1715
# Do not run session.bye() here: the session is not
1716
# established. Just abandon the request.
1718
logger.debug("Handshake succeeded")
1720
approval_required = False
1723
fpr = self.fingerprint(self.peer_certificate
1726
gnutls.errors.GNUTLSError) as error:
1727
logger.warning("Bad certificate: %s", error)
1729
logger.debug("Fingerprint: %s", fpr)
1732
client = ProxyClient(child_pipe, fpr,
1733
self.client_address)
1737
if client.approval_delay:
1738
delay = client.approval_delay
1739
client.approvals_pending += 1
1740
approval_required = True
1743
if not client.enabled:
1744
logger.info("Client %s is disabled",
1746
if self.server.use_dbus:
1748
client.Rejected("Disabled")
1751
if client.approved or not client.approval_delay:
1752
#We are approved or approval is disabled
1754
elif client.approved is None:
1755
logger.info("Client %s needs approval",
1757
if self.server.use_dbus:
1759
client.NeedApproval(
1760
client.approval_delay.total_seconds()
1761
* 1000, client.approved_by_default)
1763
logger.warning("Client %s was not approved",
1765
if self.server.use_dbus:
1767
client.Rejected("Denied")
1770
#wait until timeout or approved
1771
time = datetime.datetime.now()
1772
client.changedstate.acquire()
1773
client.changedstate.wait(delay.total_seconds())
1774
client.changedstate.release()
1775
time2 = datetime.datetime.now()
1776
if (time2 - time) >= delay:
1777
if not client.approved_by_default:
1778
logger.warning("Client %s timed out while"
1779
" waiting for approval",
1781
if self.server.use_dbus:
1783
client.Rejected("Approval timed out")
1788
delay -= time2 - time
1791
while sent_size < len(client.secret):
1793
sent = session.send(client.secret[sent_size:])
1794
except gnutls.errors.GNUTLSError as error:
1795
logger.warning("gnutls send failed",
1798
logger.debug("Sent: %d, remaining: %d",
1799
sent, len(client.secret)
1800
- (sent_size + sent))
1803
logger.info("Sending secret to %s", client.name)
1804
# bump the timeout using extended_timeout
1805
client.bump_timeout(client.extended_timeout)
1806
if self.server.use_dbus:
1811
if approval_required:
1812
client.approvals_pending -= 1
1815
except gnutls.errors.GNUTLSError as error:
1816
logger.warning("GnuTLS bye failed",
1820
def peer_certificate(session):
1821
"Return the peer's OpenPGP certificate as a bytestring"
1822
# If not an OpenPGP certificate...
1823
if (gnutls.library.functions
1824
.gnutls_certificate_type_get(session._c_object)
1825
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1826
# ...do the normal thing
1827
return session.peer_certificate
1828
list_size = ctypes.c_uint(1)
1829
cert_list = (gnutls.library.functions
1830
.gnutls_certificate_get_peers
1831
(session._c_object, ctypes.byref(list_size)))
1832
if not bool(cert_list) and list_size.value != 0:
1833
raise gnutls.errors.GNUTLSError("error getting peer"
1835
if list_size.value == 0:
1838
return ctypes.string_at(cert.data, cert.size)
1841
def fingerprint(openpgp):
1842
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1843
# New GnuTLS "datum" with the OpenPGP public key
1844
datum = (gnutls.library.types
1845
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1848
ctypes.c_uint(len(openpgp))))
1849
# New empty GnuTLS certificate
1850
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1851
(gnutls.library.functions
1852
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1853
# Import the OpenPGP public key into the certificate
1854
(gnutls.library.functions
1855
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1856
gnutls.library.constants
1857
.GNUTLS_OPENPGP_FMT_RAW))
1858
# Verify the self signature in the key
1859
crtverify = ctypes.c_uint()
1860
(gnutls.library.functions
1861
.gnutls_openpgp_crt_verify_self(crt, 0,
1862
ctypes.byref(crtverify)))
1863
if crtverify.value != 0:
1864
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1865
raise (gnutls.errors.CertificateSecurityError
1867
# New buffer for the fingerprint
1868
buf = ctypes.create_string_buffer(20)
1869
buf_len = ctypes.c_size_t()
1870
# Get the fingerprint from the certificate into the buffer
1871
(gnutls.library.functions
1872
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1873
ctypes.byref(buf_len)))
1874
# Deinit the certificate
1875
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1876
# Convert the buffer to a Python bytestring
1877
fpr = ctypes.string_at(buf, buf_len.value)
1878
# Convert the bytestring to hexadecimal notation
1879
hex_fpr = binascii.hexlify(fpr).upper()
1883
class MultiprocessingMixIn(object):
1884
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1885
def sub_process_main(self, request, address):
1887
self.finish_request(request, address)
1889
self.handle_error(request, address)
1890
self.close_request(request)
1892
def process_request(self, request, address):
1893
"""Start a new process to process the request."""
1894
proc = multiprocessing.Process(target = self.sub_process_main,
1895
args = (request, address))
1900
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1901
""" adds a pipe to the MixIn """
1902
def process_request(self, request, client_address):
1903
"""Overrides and wraps the original process_request().
1905
This function creates a new pipe in self.pipe
1907
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1909
proc = MultiprocessingMixIn.process_request(self, request,
1911
self.child_pipe.close()
1912
self.add_pipe(parent_pipe, proc)
1914
def add_pipe(self, parent_pipe, proc):
1915
"""Dummy function; override as necessary"""
1916
raise NotImplementedError()
1919
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1920
socketserver.TCPServer, object):
1921
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
496
settings: Server settings
497
clients: Set() of Client objects
1924
enabled: Boolean; whether this server is activated yet
1925
interface: None or a network interface name (string)
1926
use_ipv6: Boolean; to use IPv6 or not
499
address_family = socket.AF_INET6
500
def __init__(self, *args, **kwargs):
501
if "settings" in kwargs:
502
self.settings = kwargs["settings"]
503
del kwargs["settings"]
504
if "clients" in kwargs:
505
self.clients = kwargs["clients"]
506
del kwargs["clients"]
507
return super(type(self), self).__init__(*args, **kwargs)
1928
def __init__(self, server_address, RequestHandlerClass,
1929
interface=None, use_ipv6=True, socketfd=None):
1930
"""If socketfd is set, use that file descriptor instead of
1931
creating a new one with socket.socket().
1933
self.interface = interface
1935
self.address_family = socket.AF_INET6
1936
if socketfd is not None:
1937
# Save the file descriptor
1938
self.socketfd = socketfd
1939
# Save the original socket.socket() function
1940
self.socket_socket = socket.socket
1941
# To implement --socket, we monkey patch socket.socket.
1943
# (When socketserver.TCPServer is a new-style class, we
1944
# could make self.socket into a property instead of monkey
1945
# patching socket.socket.)
1947
# Create a one-time-only replacement for socket.socket()
1948
@functools.wraps(socket.socket)
1949
def socket_wrapper(*args, **kwargs):
1950
# Restore original function so subsequent calls are
1952
socket.socket = self.socket_socket
1953
del self.socket_socket
1954
# This time only, return a new socket object from the
1955
# saved file descriptor.
1956
return socket.fromfd(self.socketfd, *args, **kwargs)
1957
# Replace socket.socket() function with wrapper
1958
socket.socket = socket_wrapper
1959
# The socketserver.TCPServer.__init__ will call
1960
# socket.socket(), which might be our replacement,
1961
# socket_wrapper(), if socketfd was set.
1962
socketserver.TCPServer.__init__(self, server_address,
1963
RequestHandlerClass)
508
1965
def server_bind(self):
509
1966
"""This overrides the normal server_bind() function
510
1967
to bind to an interface if one was specified, and also NOT to
511
1968
bind to an address or port if they were not specified."""
512
if self.settings["interface"]:
513
# 25 is from /usr/include/asm-i486/socket.h
514
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
516
self.socket.setsockopt(socket.SOL_SOCKET,
518
self.settings["interface"])
519
except socket.error, error:
520
if error[0] == errno.EPERM:
521
logger.warning(u"No permission to"
522
u" bind to interface %s",
523
self.settings["interface"])
1969
if self.interface is not None:
1970
if SO_BINDTODEVICE is None:
1971
logger.error("SO_BINDTODEVICE does not exist;"
1972
" cannot bind to interface %s",
1976
self.socket.setsockopt(socket.SOL_SOCKET,
1978
(self.interface + "\0")
1980
except socket.error as error:
1981
if error.errno == errno.EPERM:
1982
logger.error("No permission to bind to"
1983
" interface %s", self.interface)
1984
elif error.errno == errno.ENOPROTOOPT:
1985
logger.error("SO_BINDTODEVICE not available;"
1986
" cannot bind to interface %s",
1988
elif error.errno == errno.ENODEV:
1989
logger.error("Interface %s does not exist,"
1990
" cannot bind", self.interface)
526
1993
# Only bind(2) the socket if we really need to.
527
1994
if self.server_address[0] or self.server_address[1]:
528
1995
if not self.server_address[0]:
530
self.server_address = (in6addr_any,
1996
if self.address_family == socket.AF_INET6:
1997
any_address = "::" # in6addr_any
1999
any_address = "0.0.0.0" # INADDR_ANY
2000
self.server_address = (any_address,
531
2001
self.server_address[1])
532
elif self.server_address[1] is None:
2002
elif not self.server_address[1]:
533
2003
self.server_address = (self.server_address[0],
535
return super(type(self), self).server_bind()
2005
# if self.interface:
2006
# self.server_address = (self.server_address[0],
2011
return socketserver.TCPServer.server_bind(self)
2014
class MandosServer(IPv6_TCPServer):
2018
clients: set of Client objects
2019
gnutls_priority GnuTLS priority string
2020
use_dbus: Boolean; to emit D-Bus signals or not
2022
Assumes a gobject.MainLoop event loop.
2024
def __init__(self, server_address, RequestHandlerClass,
2025
interface=None, use_ipv6=True, clients=None,
2026
gnutls_priority=None, use_dbus=True, socketfd=None):
2027
self.enabled = False
2028
self.clients = clients
2029
if self.clients is None:
2031
self.use_dbus = use_dbus
2032
self.gnutls_priority = gnutls_priority
2033
IPv6_TCPServer.__init__(self, server_address,
2034
RequestHandlerClass,
2035
interface = interface,
2036
use_ipv6 = use_ipv6,
2037
socketfd = socketfd)
2038
def server_activate(self):
2040
return socketserver.TCPServer.server_activate(self)
2045
def add_pipe(self, parent_pipe, proc):
2046
# Call "handle_ipc" for both data and EOF events
2047
gobject.io_add_watch(parent_pipe.fileno(),
2048
gobject.IO_IN | gobject.IO_HUP,
2049
functools.partial(self.handle_ipc,
2054
def handle_ipc(self, source, condition, parent_pipe=None,
2055
proc = None, client_object=None):
2056
# error, or the other end of multiprocessing.Pipe has closed
2057
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2058
# Wait for other process to exit
2062
# Read a request from the child
2063
request = parent_pipe.recv()
2064
command = request[0]
2066
if command == 'init':
2068
address = request[2]
2070
for c in self.clients.itervalues():
2071
if c.fingerprint == fpr:
2075
logger.info("Client not found for fingerprint: %s, ad"
2076
"dress: %s", fpr, address)
2079
mandos_dbus_service.ClientNotFound(fpr,
2081
parent_pipe.send(False)
2084
gobject.io_add_watch(parent_pipe.fileno(),
2085
gobject.IO_IN | gobject.IO_HUP,
2086
functools.partial(self.handle_ipc,
2092
parent_pipe.send(True)
2093
# remove the old hook in favor of the new above hook on
2096
if command == 'funcall':
2097
funcname = request[1]
2101
parent_pipe.send(('data', getattr(client_object,
2105
if command == 'getattr':
2106
attrname = request[1]
2107
if callable(client_object.__getattribute__(attrname)):
2108
parent_pipe.send(('function',))
2110
parent_pipe.send(('data', client_object
2111
.__getattribute__(attrname)))
2113
if command == 'setattr':
2114
attrname = request[1]
2116
setattr(client_object, attrname, value)
2121
def rfc3339_duration_to_delta(duration):
2122
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2124
>>> rfc3339_duration_to_delta("P7D")
2125
datetime.timedelta(7)
2126
>>> rfc3339_duration_to_delta("PT60S")
2127
datetime.timedelta(0, 60)
2128
>>> rfc3339_duration_to_delta("PT60M")
2129
datetime.timedelta(0, 3600)
2130
>>> rfc3339_duration_to_delta("PT24H")
2131
datetime.timedelta(1)
2132
>>> rfc3339_duration_to_delta("P1W")
2133
datetime.timedelta(7)
2134
>>> rfc3339_duration_to_delta("PT5M30S")
2135
datetime.timedelta(0, 330)
2136
>>> rfc3339_duration_to_delta("P1DT3M20S")
2137
datetime.timedelta(1, 200)
2140
# Parsing an RFC 3339 duration with regular expressions is not
2141
# possible - there would have to be multiple places for the same
2142
# values, like seconds. The current code, while more esoteric, is
2143
# cleaner without depending on a parsing library. If Python had a
2144
# built-in library for parsing we would use it, but we'd like to
2145
# avoid excessive use of external libraries.
2147
# New type for defining tokens, syntax, and semantics all-in-one
2148
Token = collections.namedtuple("Token",
2149
("regexp", # To match token; if
2150
# "value" is not None,
2151
# must have a "group"
2153
"value", # datetime.timedelta or
2155
"followers")) # Tokens valid after
2157
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2158
# the "duration" ABNF definition in RFC 3339, Appendix A.
2159
token_end = Token(re.compile(r"$"), None, frozenset())
2160
token_second = Token(re.compile(r"(\d+)S"),
2161
datetime.timedelta(seconds=1),
2162
frozenset((token_end,)))
2163
token_minute = Token(re.compile(r"(\d+)M"),
2164
datetime.timedelta(minutes=1),
2165
frozenset((token_second, token_end)))
2166
token_hour = Token(re.compile(r"(\d+)H"),
2167
datetime.timedelta(hours=1),
2168
frozenset((token_minute, token_end)))
2169
token_time = Token(re.compile(r"T"),
2171
frozenset((token_hour, token_minute,
2173
token_day = Token(re.compile(r"(\d+)D"),
2174
datetime.timedelta(days=1),
2175
frozenset((token_time, token_end)))
2176
token_month = Token(re.compile(r"(\d+)M"),
2177
datetime.timedelta(weeks=4),
2178
frozenset((token_day, token_end)))
2179
token_year = Token(re.compile(r"(\d+)Y"),
2180
datetime.timedelta(weeks=52),
2181
frozenset((token_month, token_end)))
2182
token_week = Token(re.compile(r"(\d+)W"),
2183
datetime.timedelta(weeks=1),
2184
frozenset((token_end,)))
2185
token_duration = Token(re.compile(r"P"), None,
2186
frozenset((token_year, token_month,
2187
token_day, token_time,
2189
# Define starting values
2190
value = datetime.timedelta() # Value so far
2192
followers = frozenset((token_duration,)) # Following valid tokens
2193
s = duration # String left to parse
2194
# Loop until end token is found
2195
while found_token is not token_end:
2196
# Search for any currently valid tokens
2197
for token in followers:
2198
match = token.regexp.match(s)
2199
if match is not None:
2201
if token.value is not None:
2202
# Value found, parse digits
2203
factor = int(match.group(1), 10)
2204
# Add to value so far
2205
value += factor * token.value
2206
# Strip token from string
2207
s = token.regexp.sub("", s, 1)
2210
# Set valid next tokens
2211
followers = found_token.followers
2214
# No currently valid tokens were found
2215
raise ValueError("Invalid RFC 3339 duration")
538
2220
def string_to_delta(interval):
539
2221
"""Parse a string and return a datetime.timedelta
541
2223
>>> string_to_delta('7d')
542
2224
datetime.timedelta(7)
543
2225
>>> string_to_delta('60s')
685
2351
"debug": "False",
687
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2353
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
688
2354
"servicename": "Mandos",
2360
"statedir": "/var/lib/mandos",
2361
"foreground": "False",
691
2365
# Parse config file for server-global settings
692
server_config = ConfigParser.SafeConfigParser(server_defaults)
2366
server_config = configparser.SafeConfigParser(server_defaults)
693
2367
del server_defaults
694
server_config.read(os.path.join(options.configdir, "server.conf"))
695
server_section = "server"
2368
server_config.read(os.path.join(options.configdir,
696
2370
# Convert the SafeConfigParser object to a dict
697
server_settings = dict(server_config.items(server_section))
698
# Use getboolean on the boolean config option
699
server_settings["debug"] = server_config.getboolean\
700
(server_section, "debug")
2371
server_settings = server_config.defaults()
2372
# Use the appropriate methods on the non-string config options
2373
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2374
server_settings[option] = server_config.getboolean("DEFAULT",
2376
if server_settings["port"]:
2377
server_settings["port"] = server_config.getint("DEFAULT",
2379
if server_settings["socket"]:
2380
server_settings["socket"] = server_config.getint("DEFAULT",
2382
# Later, stdin will, and stdout and stderr might, be dup'ed
2383
# over with an opened os.devnull. But we don't want this to
2384
# happen with a supplied network socket.
2385
if 0 <= server_settings["socket"] <= 2:
2386
server_settings["socket"] = os.dup(server_settings
701
2388
del server_config
703
2390
# Override the settings from the config file with command line
704
2391
# options, if set.
705
2392
for option in ("interface", "address", "port", "debug",
706
"priority", "servicename", "configdir"):
2393
"priority", "servicename", "configdir",
2394
"use_dbus", "use_ipv6", "debuglevel", "restore",
2395
"statedir", "socket", "foreground", "zeroconf"):
707
2396
value = getattr(options, option)
708
2397
if value is not None:
709
2398
server_settings[option] = value
2400
# Force all strings to be unicode
2401
for option in server_settings.keys():
2402
if isinstance(server_settings[option], bytes):
2403
server_settings[option] = (server_settings[option]
2405
# Force all boolean options to be boolean
2406
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2407
"foreground", "zeroconf"):
2408
server_settings[option] = bool(server_settings[option])
2409
# Debug implies foreground
2410
if server_settings["debug"]:
2411
server_settings["foreground"] = True
711
2412
# Now we have our good server settings in "server_settings"
2414
##################################################################
2416
if (not server_settings["zeroconf"] and
2417
not (server_settings["port"]
2418
or server_settings["socket"] != "")):
2419
parser.error("Needs port or socket to work without"
2423
debug = server_settings["debug"]
2424
debuglevel = server_settings["debuglevel"]
2425
use_dbus = server_settings["use_dbus"]
2426
use_ipv6 = server_settings["use_ipv6"]
2427
stored_state_path = os.path.join(server_settings["statedir"],
2429
foreground = server_settings["foreground"]
2430
zeroconf = server_settings["zeroconf"]
2433
initlogger(debug, logging.DEBUG)
2438
level = getattr(logging, debuglevel.upper())
2439
initlogger(debug, level)
2441
if server_settings["servicename"] != "Mandos":
2442
syslogger.setFormatter(logging.Formatter
2443
('Mandos ({}) [%(process)d]:'
2444
' %(levelname)s: %(message)s'
2445
.format(server_settings
713
2448
# Parse config file with clients
714
client_defaults = { "timeout": "1h",
716
"checker": "fping -q -- %%(fqdn)s",
718
client_config = ConfigParser.SafeConfigParser(client_defaults)
2449
client_config = configparser.SafeConfigParser(Client
719
2451
client_config.read(os.path.join(server_settings["configdir"],
720
2452
"clients.conf"))
723
service = AvahiService(name = server_settings["servicename"],
724
type = "_mandos._tcp", );
725
if server_settings["interface"]:
726
service.interface = if_nametoindex(server_settings["interface"])
2454
global mandos_dbus_service
2455
mandos_dbus_service = None
2458
if server_settings["socket"] != "":
2459
socketfd = server_settings["socket"]
2460
tcp_server = MandosServer((server_settings["address"],
2461
server_settings["port"]),
2463
interface=(server_settings["interface"]
2467
server_settings["priority"],
2471
pidfilename = "/run/mandos.pid"
2472
if not os.path.isdir("/run/."):
2473
pidfilename = "/var/run/mandos.pid"
2476
pidfile = open(pidfilename, "w")
2477
except IOError as e:
2478
logger.error("Could not open file %r", pidfilename,
2481
for name in ("_mandos", "mandos", "nobody"):
2483
uid = pwd.getpwnam(name).pw_uid
2484
gid = pwd.getpwnam(name).pw_gid
2494
except OSError as error:
2495
if error.errno != errno.EPERM:
2499
# Enable all possible GnuTLS debugging
2501
# "Use a log level over 10 to enable all debugging options."
2503
gnutls.library.functions.gnutls_global_set_log_level(11)
2505
@gnutls.library.types.gnutls_log_func
2506
def debug_gnutls(level, string):
2507
logger.debug("GnuTLS: %s", string[:-1])
2509
(gnutls.library.functions
2510
.gnutls_global_set_log_function(debug_gnutls))
2512
# Redirect stdin so all checkers get /dev/null
2513
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2514
os.dup2(null, sys.stdin.fileno())
2518
# Need to fork before connecting to D-Bus
2520
# Close all input and output, do double fork, etc.
2523
# multiprocessing will use threads, so before we use gobject we
2524
# need to inform gobject that threads will be used.
2525
gobject.threads_init()
728
2527
global main_loop
731
2528
# From the Avahi example code
732
DBusGMainLoop(set_as_default=True )
2529
DBusGMainLoop(set_as_default=True)
733
2530
main_loop = gobject.MainLoop()
734
2531
bus = dbus.SystemBus()
735
server = dbus.Interface(
736
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
737
avahi.DBUS_INTERFACE_SERVER )
738
2532
# End of Avahi example code
740
debug = server_settings["debug"]
743
console = logging.StreamHandler()
744
# console.setLevel(logging.DEBUG)
745
console.setFormatter(logging.Formatter\
746
('%(levelname)s: %(message)s'))
747
logger.addHandler(console)
751
def remove_from_clients(client):
752
clients.remove(client)
754
logger.debug(u"No clients left, exiting")
757
clients.update(Set(Client(name=section,
758
stop_hook = remove_from_clients,
759
**(dict(client_config\
761
for section in client_config.sections()))
2535
bus_name = dbus.service.BusName("se.recompile.Mandos",
2536
bus, do_not_queue=True)
2537
old_bus_name = (dbus.service.BusName
2538
("se.bsnet.fukt.Mandos", bus,
2540
except dbus.exceptions.NameExistsException as e:
2541
logger.error("Disabling D-Bus:", exc_info=e)
2543
server_settings["use_dbus"] = False
2544
tcp_server.use_dbus = False
2546
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2547
service = AvahiServiceToSyslog(name =
2548
server_settings["servicename"],
2549
servicetype = "_mandos._tcp",
2550
protocol = protocol, bus = bus)
2551
if server_settings["interface"]:
2552
service.interface = (if_nametoindex
2553
(server_settings["interface"]
2556
global multiprocessing_manager
2557
multiprocessing_manager = multiprocessing.Manager()
2559
client_class = Client
2561
client_class = functools.partial(ClientDBus, bus = bus)
2563
client_settings = Client.config_parser(client_config)
2564
old_client_settings = {}
2567
# This is used to redirect stdout and stderr for checker processes
2569
wnull = open(os.devnull, "w") # A writable /dev/null
2570
# Only used if server is running in foreground but not in debug
2572
if debug or not foreground:
2575
# Get client data and settings from last running state.
2576
if server_settings["restore"]:
2578
with open(stored_state_path, "rb") as stored_state:
2579
clients_data, old_client_settings = (pickle.load
2581
os.remove(stored_state_path)
2582
except IOError as e:
2583
if e.errno == errno.ENOENT:
2584
logger.warning("Could not load persistent state: {}"
2585
.format(os.strerror(e.errno)))
2587
logger.critical("Could not load persistent state:",
2590
except EOFError as e:
2591
logger.warning("Could not load persistent state: "
2592
"EOFError:", exc_info=e)
2594
with PGPEngine() as pgp:
2595
for client_name, client in clients_data.items():
2596
# Skip removed clients
2597
if client_name not in client_settings:
2600
# Decide which value to use after restoring saved state.
2601
# We have three different values: Old config file,
2602
# new config file, and saved state.
2603
# New config value takes precedence if it differs from old
2604
# config value, otherwise use saved state.
2605
for name, value in client_settings[client_name].items():
2607
# For each value in new config, check if it
2608
# differs from the old config value (Except for
2609
# the "secret" attribute)
2610
if (name != "secret" and
2611
value != old_client_settings[client_name]
2613
client[name] = value
2617
# Clients who has passed its expire date can still be
2618
# enabled if its last checker was successful. Clients
2619
# whose checker succeeded before we stored its state is
2620
# assumed to have successfully run all checkers during
2622
if client["enabled"]:
2623
if datetime.datetime.utcnow() >= client["expires"]:
2624
if not client["last_checked_ok"]:
2626
"disabling client {} - Client never "
2627
"performed a successful checker"
2628
.format(client_name))
2629
client["enabled"] = False
2630
elif client["last_checker_status"] != 0:
2632
"disabling client {} - Client last"
2633
" checker failed with error code {}"
2634
.format(client_name,
2635
client["last_checker_status"]))
2636
client["enabled"] = False
2638
client["expires"] = (datetime.datetime
2640
+ client["timeout"])
2641
logger.debug("Last checker succeeded,"
2642
" keeping {} enabled"
2643
.format(client_name))
2645
client["secret"] = (
2646
pgp.decrypt(client["encrypted_secret"],
2647
client_settings[client_name]
2650
# If decryption fails, we use secret from new settings
2651
logger.debug("Failed to decrypt {} old secret"
2652
.format(client_name))
2653
client["secret"] = (
2654
client_settings[client_name]["secret"])
2656
# Add/remove clients based on new changes made to config
2657
for client_name in (set(old_client_settings)
2658
- set(client_settings)):
2659
del clients_data[client_name]
2660
for client_name in (set(client_settings)
2661
- set(old_client_settings)):
2662
clients_data[client_name] = client_settings[client_name]
2664
# Create all client objects
2665
for client_name, client in clients_data.items():
2666
tcp_server.clients[client_name] = client_class(
2667
name = client_name, settings = client,
2668
server_settings = server_settings)
2670
if not tcp_server.clients:
2671
logger.warning("No clients defined")
2674
if pidfile is not None:
2678
pidfile.write("{}\n".format(pid).encode("utf-8"))
2680
logger.error("Could not write to file %r with PID %d",
2685
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2686
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2689
@alternate_dbus_interfaces({"se.recompile.Mandos":
2690
"se.bsnet.fukt.Mandos"})
2691
class MandosDBusService(DBusObjectWithProperties):
2692
"""A D-Bus proxy object"""
2694
dbus.service.Object.__init__(self, bus, "/")
2695
_interface = "se.recompile.Mandos"
2697
@dbus_interface_annotations(_interface)
2699
return { "org.freedesktop.DBus.Property"
2700
".EmitsChangedSignal":
2703
@dbus.service.signal(_interface, signature="o")
2704
def ClientAdded(self, objpath):
2708
@dbus.service.signal(_interface, signature="ss")
2709
def ClientNotFound(self, fingerprint, address):
2713
@dbus.service.signal(_interface, signature="os")
2714
def ClientRemoved(self, objpath, name):
2718
@dbus.service.method(_interface, out_signature="ao")
2719
def GetAllClients(self):
2721
return dbus.Array(c.dbus_object_path
2723
tcp_server.clients.itervalues())
2725
@dbus.service.method(_interface,
2726
out_signature="a{oa{sv}}")
2727
def GetAllClientsWithProperties(self):
2729
return dbus.Dictionary(
2730
{ c.dbus_object_path: c.GetAll("")
2731
for c in tcp_server.clients.itervalues() },
2734
@dbus.service.method(_interface, in_signature="o")
2735
def RemoveClient(self, object_path):
2737
for c in tcp_server.clients.itervalues():
2738
if c.dbus_object_path == object_path:
2739
del tcp_server.clients[c.name]
2740
c.remove_from_connection()
2741
# Don't signal anything except ClientRemoved
2742
c.disable(quiet=True)
2744
self.ClientRemoved(object_path, c.name)
2746
raise KeyError(object_path)
2750
mandos_dbus_service = MandosDBusService()
767
2753
"Cleanup function; run on exit"
769
# From the Avahi example code
770
if not group is None:
773
# End of Avahi example code
776
client = clients.pop()
777
client.stop_hook = None
2757
multiprocessing.active_children()
2759
if not (tcp_server.clients or client_settings):
2762
# Store client before exiting. Secrets are encrypted with key
2763
# based on what config file has. If config file is
2764
# removed/edited, old secret will thus be unrecovable.
2766
with PGPEngine() as pgp:
2767
for client in tcp_server.clients.itervalues():
2768
key = client_settings[client.name]["secret"]
2769
client.encrypted_secret = pgp.encrypt(client.secret,
2773
# A list of attributes that can not be pickled
2775
exclude = { "bus", "changedstate", "secret",
2776
"checker", "server_settings" }
2777
for name, typ in (inspect.getmembers
2778
(dbus.service.Object)):
2781
client_dict["encrypted_secret"] = (client
2783
for attr in client.client_structure:
2784
if attr not in exclude:
2785
client_dict[attr] = getattr(client, attr)
2787
clients[client.name] = client_dict
2788
del client_settings[client.name]["secret"]
2791
with (tempfile.NamedTemporaryFile
2792
(mode='wb', suffix=".pickle", prefix='clients-',
2793
dir=os.path.dirname(stored_state_path),
2794
delete=False)) as stored_state:
2795
pickle.dump((clients, client_settings), stored_state)
2796
tempname=stored_state.name
2797
os.rename(tempname, stored_state_path)
2798
except (IOError, OSError) as e:
2804
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2805
logger.warning("Could not save persistent state: {}"
2806
.format(os.strerror(e.errno)))
2808
logger.warning("Could not save persistent state:",
2812
# Delete all clients, and settings from config
2813
while tcp_server.clients:
2814
name, client = tcp_server.clients.popitem()
2816
client.remove_from_connection()
2817
# Don't signal anything except ClientRemoved
2818
client.disable(quiet=True)
2821
mandos_dbus_service.ClientRemoved(client
2824
client_settings.clear()
780
2826
atexit.register(cleanup)
783
signal.signal(signal.SIGINT, signal.SIG_IGN)
784
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
785
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
787
for client in clients:
790
tcp_server = IPv6_TCPServer((server_settings["address"],
791
server_settings["port"]),
793
settings=server_settings,
2828
for client in tcp_server.clients.itervalues():
2831
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2832
# Need to initiate checking of clients
2834
client.init_checker()
2837
tcp_server.server_activate()
795
2839
# Find out what port we got
796
service.port = tcp_server.socket.getsockname()[1]
797
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
798
u" scope_id %d" % tcp_server.socket.getsockname())
2841
service.port = tcp_server.socket.getsockname()[1]
2843
logger.info("Now listening on address %r, port %d,"
2844
" flowinfo %d, scope_id %d",
2845
*tcp_server.socket.getsockname())
2847
logger.info("Now listening on address %r, port %d",
2848
*tcp_server.socket.getsockname())
800
2850
#service.interface = tcp_server.socket.getsockname()[3]
803
# From the Avahi example code
804
server.connect_to_signal("StateChanged", server_state_changed)
806
server_state_changed(server.GetState())
807
except dbus.exceptions.DBusException, error:
808
logger.critical(u"DBusException: %s", error)
810
# End of Avahi example code
2854
# From the Avahi example code
2857
except dbus.exceptions.DBusException as error:
2858
logger.critical("D-Bus Exception", exc_info=error)
2861
# End of Avahi example code
812
2863
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
813
2864
lambda *args, **kwargs:
814
tcp_server.handle_request\
815
(*args[2:], **kwargs) or True)
2865
(tcp_server.handle_request
2866
(*args[2:], **kwargs) or True))
817
2868
logger.debug("Starting main loop")
818
main_loop_started = True
820
except AvahiError, error:
821
logger.critical(u"AvahiError: %s" + unicode(error))
2870
except AvahiError as error:
2871
logger.critical("Avahi Error", exc_info=error)
823
2874
except KeyboardInterrupt:
2876
print("", file=sys.stderr)
2877
logger.debug("Server received KeyboardInterrupt")
2878
logger.debug("Server exiting")
2879
# Must run before the D-Bus bus name gets deregistered
827
2882
if __name__ == '__main__':