164
171
# End of Avahi example code
167
class Client(object):
174
def _datetime_to_dbus(dt, variant_level=0):
175
"""Convert a UTC datetime.datetime() to a D-Bus type."""
176
return dbus.String(dt.isoformat(), variant_level=variant_level)
179
class Client(dbus.service.Object):
168
180
"""A representation of a client host served by this server.
170
name: string; from the config file, used in log messages
182
name: string; from the config file, used in log messages and
171
184
fingerprint: string (40 or 32 hexadecimal digits); used to
172
185
uniquely identify the client
173
secret: bytestring; sent verbatim (over TLS) to client
174
host: string; available for use by the checker command
175
created: datetime.datetime(); object creation, not client host
176
last_checked_ok: datetime.datetime() or None if not yet checked OK
177
timeout: datetime.timedelta(); How long from last_checked_ok
178
until this client is invalid
179
interval: datetime.timedelta(); How often to start a new checker
180
stop_hook: If set, called by stop() as stop_hook(self)
181
checker: subprocess.Popen(); a running checker process used
182
to see if the client lives.
183
'None' if no process is running.
186
secret: bytestring; sent verbatim (over TLS) to client
187
host: string; available for use by the checker command
188
created: datetime.datetime(); (UTC) object creation
189
last_enabled: datetime.datetime(); (UTC)
191
last_checked_ok: datetime.datetime(); (UTC) or None
192
timeout: datetime.timedelta(); How long from last_checked_ok
193
until this client is invalid
194
interval: datetime.timedelta(); How often to start a new checker
195
disable_hook: If set, called by disable() as disable_hook(self)
196
checker: subprocess.Popen(); a running checker process used
197
to see if the client lives.
198
'None' if no process is running.
184
199
checker_initiator_tag: a gobject event source tag, or None
185
stop_initiator_tag: - '' -
200
disable_initiator_tag: - '' -
186
201
checker_callback_tag: - '' -
187
202
checker_command: string; External command which is run to check if
188
203
client lives. %() expansions are done at
189
204
runtime with vars(self) as dict, so that for
190
205
instance %(name)s can be used in the command.
192
_timeout: Real variable for 'timeout'
193
_interval: Real variable for 'interval'
194
_timeout_milliseconds: Used when calling gobject.timeout_add()
195
_interval_milliseconds: - '' -
206
use_dbus: bool(); Whether to provide D-Bus interface and signals
207
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
197
def _set_timeout(self, timeout):
198
"Setter function for 'timeout' attribute"
199
self._timeout = timeout
200
self._timeout_milliseconds = ((self.timeout.days
201
* 24 * 60 * 60 * 1000)
202
+ (self.timeout.seconds * 1000)
203
+ (self.timeout.microseconds
205
timeout = property(lambda self: self._timeout,
208
def _set_interval(self, interval):
209
"Setter function for 'interval' attribute"
210
self._interval = interval
211
self._interval_milliseconds = ((self.interval.days
212
* 24 * 60 * 60 * 1000)
213
+ (self.interval.seconds
215
+ (self.interval.microseconds
217
interval = property(lambda self: self._interval,
220
def __init__(self, name = None, stop_hook=None, config={}):
209
def timeout_milliseconds(self):
210
"Return the 'timeout' attribute in milliseconds"
211
return ((self.timeout.days * 24 * 60 * 60 * 1000)
212
+ (self.timeout.seconds * 1000)
213
+ (self.timeout.microseconds // 1000))
215
def interval_milliseconds(self):
216
"Return the 'interval' attribute in milliseconds"
217
return ((self.interval.days * 24 * 60 * 60 * 1000)
218
+ (self.interval.seconds * 1000)
219
+ (self.interval.microseconds // 1000))
221
def __init__(self, name = None, disable_hook=None, config=None,
221
223
"""Note: the 'checker' key in 'config' sets the
222
224
'checker_command' attribute and *not* the 'checker'
225
229
logger.debug(u"Creating client %r", self.name)
230
self.use_dbus = False # During __init__
226
231
# Uppercase and remove spaces from fingerprint for later
227
232
# comparison purposes with return value from the fingerprint()
229
self.fingerprint = config["fingerprint"].upper()\
234
self.fingerprint = (config["fingerprint"].upper()
231
236
logger.debug(u" Fingerprint: %s", self.fingerprint)
232
237
if "secret" in config:
233
238
self.secret = config["secret"].decode(u"base64")
234
239
elif "secfile" in config:
235
sf = open(config["secfile"])
236
self.secret = sf.read()
240
with closing(open(os.path.expanduser
242
(config["secfile"])))) as secfile:
243
self.secret = secfile.read()
239
245
raise TypeError(u"No secret or secfile for client %s"
241
247
self.host = config.get("host", "")
242
self.created = datetime.datetime.now()
248
self.created = datetime.datetime.utcnow()
250
self.last_enabled = None
243
251
self.last_checked_ok = None
244
252
self.timeout = string_to_delta(config["timeout"])
245
253
self.interval = string_to_delta(config["interval"])
246
self.stop_hook = stop_hook
254
self.disable_hook = disable_hook
247
255
self.checker = None
248
256
self.checker_initiator_tag = None
249
self.stop_initiator_tag = None
257
self.disable_initiator_tag = None
250
258
self.checker_callback_tag = None
251
self.check_command = config["checker"]
259
self.checker_command = config["checker"]
260
self.last_connect = None
261
# Only now, when this client is initialized, can it show up on
263
self.use_dbus = use_dbus
265
self.dbus_object_path = (dbus.ObjectPath
267
+ self.name.replace(".", "_")))
268
dbus.service.Object.__init__(self, bus,
269
self.dbus_object_path)
253
272
"""Start this client's checker and timeout hooks"""
273
self.last_enabled = datetime.datetime.utcnow()
254
274
# Schedule a new checker to be started an 'interval' from now,
255
275
# and every interval from then on.
256
self.checker_initiator_tag = gobject.timeout_add\
257
(self._interval_milliseconds,
276
self.checker_initiator_tag = (gobject.timeout_add
277
(self.interval_milliseconds(),
259
279
# Also start a new checker *right now*.
260
280
self.start_checker()
261
# Schedule a stop() when 'timeout' has passed
262
self.stop_initiator_tag = gobject.timeout_add\
263
(self._timeout_milliseconds,
267
The possibility that a client might be restarted is left open,
268
but not currently used."""
269
# If this client doesn't have a secret, it is already stopped.
270
if hasattr(self, "secret") and self.secret:
271
logger.info(u"Stopping client %s", self.name)
281
# Schedule a disable() when 'timeout' has passed
282
self.disable_initiator_tag = (gobject.timeout_add
283
(self.timeout_milliseconds(),
288
self.PropertyChanged(dbus.String(u"enabled"),
289
dbus.Boolean(True, variant_level=1))
290
self.PropertyChanged(dbus.String(u"last_enabled"),
291
(_datetime_to_dbus(self.last_enabled,
295
"""Disable this client."""
296
if not getattr(self, "enabled", False):
275
if getattr(self, "stop_initiator_tag", False):
276
gobject.source_remove(self.stop_initiator_tag)
277
self.stop_initiator_tag = None
298
logger.info(u"Disabling client %s", self.name)
299
if getattr(self, "disable_initiator_tag", False):
300
gobject.source_remove(self.disable_initiator_tag)
301
self.disable_initiator_tag = None
278
302
if getattr(self, "checker_initiator_tag", False):
279
303
gobject.source_remove(self.checker_initiator_tag)
280
304
self.checker_initiator_tag = None
281
305
self.stop_checker()
306
if self.disable_hook:
307
self.disable_hook(self)
311
self.PropertyChanged(dbus.String(u"enabled"),
312
dbus.Boolean(False, variant_level=1))
284
313
# Do not run this again if called by a gobject.timeout_add
286
316
def __del__(self):
287
self.stop_hook = None
289
def checker_callback(self, pid, condition):
317
self.disable_hook = None
320
def checker_callback(self, pid, condition, command):
290
321
"""The checker has completed, so take appropriate actions."""
291
now = datetime.datetime.now()
292
322
self.checker_callback_tag = None
293
323
self.checker = None
294
if os.WIFEXITED(condition) \
295
and (os.WEXITSTATUS(condition) == 0):
296
logger.info(u"Checker for %(name)s succeeded",
298
self.last_checked_ok = now
299
gobject.source_remove(self.stop_initiator_tag)
300
self.stop_initiator_tag = gobject.timeout_add\
301
(self._timeout_milliseconds,
303
elif not os.WIFEXITED(condition):
326
self.PropertyChanged(dbus.String(u"checker_running"),
327
dbus.Boolean(False, variant_level=1))
328
if os.WIFEXITED(condition):
329
exitstatus = os.WEXITSTATUS(condition)
331
logger.info(u"Checker for %(name)s succeeded",
335
logger.info(u"Checker for %(name)s failed",
339
self.CheckerCompleted(dbus.Int16(exitstatus),
340
dbus.Int64(condition),
341
dbus.String(command))
304
343
logger.warning(u"Checker for %(name)s crashed?",
307
logger.info(u"Checker for %(name)s failed",
347
self.CheckerCompleted(dbus.Int16(-1),
348
dbus.Int64(condition),
349
dbus.String(command))
351
def checked_ok(self):
352
"""Bump up the timeout for this client.
353
This should only be called when the client has been seen,
356
self.last_checked_ok = datetime.datetime.utcnow()
357
gobject.source_remove(self.disable_initiator_tag)
358
self.disable_initiator_tag = (gobject.timeout_add
359
(self.timeout_milliseconds(),
363
self.PropertyChanged(
364
dbus.String(u"last_checked_ok"),
365
(_datetime_to_dbus(self.last_checked_ok,
309
368
def start_checker(self):
310
369
"""Start a new checker subprocess if one is not running.
311
370
If a checker already exists, leave it running and do
320
379
# is as it should be.
321
380
if self.checker is None:
323
# In case check_command has exactly one % operator
324
command = self.check_command % self.host
382
# In case checker_command has exactly one % operator
383
command = self.checker_command % self.host
325
384
except TypeError:
326
385
# Escape attributes for the shell
327
386
escaped_attrs = dict((key, re.escape(str(val)))
329
388
vars(self).iteritems())
331
command = self.check_command % escaped_attrs
390
command = self.checker_command % escaped_attrs
332
391
except TypeError, error:
333
392
logger.error(u'Could not format string "%s":'
334
u' %s', self.check_command, error)
393
u' %s', self.checker_command, error)
335
394
return True # Try again later
337
396
logger.info(u"Starting checker %r for %s",
338
397
command, self.name)
398
# We don't need to redirect stdout and stderr, since
399
# in normal mode, that is already done by daemon(),
400
# and in debug mode we don't want to. (Stdin is
401
# always replaced by /dev/null.)
339
402
self.checker = subprocess.Popen(command,
341
404
shell=True, cwd="/")
342
self.checker_callback_tag = gobject.child_watch_add\
344
self.checker_callback)
345
except subprocess.OSError, error:
407
self.CheckerStarted(command)
408
self.PropertyChanged(
409
dbus.String("checker_running"),
410
dbus.Boolean(True, variant_level=1))
411
self.checker_callback_tag = (gobject.child_watch_add
413
self.checker_callback,
415
# The checker may have completed before the gobject
416
# watch was added. Check for this.
417
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
419
gobject.source_remove(self.checker_callback_tag)
420
self.checker_callback(pid, status, command)
421
except OSError, error:
346
422
logger.error(u"Failed to start subprocess: %s",
348
424
# Re-run this periodically if run by gobject.timeout_add
350
427
def stop_checker(self):
351
428
"""Force the checker process, if any, to stop."""
352
429
if self.checker_callback_tag:
364
441
if error.errno != errno.ESRCH: # No such process
366
443
self.checker = None
445
self.PropertyChanged(dbus.String(u"checker_running"),
446
dbus.Boolean(False, variant_level=1))
367
448
def still_valid(self):
368
449
"""Has the timeout not yet passed for this client?"""
369
now = datetime.datetime.now()
450
if not getattr(self, "enabled", False):
452
now = datetime.datetime.utcnow()
370
453
if self.last_checked_ok is None:
371
454
return now < (self.created + self.timeout)
373
456
return now < (self.last_checked_ok + self.timeout)
458
## D-Bus methods & signals
459
_interface = u"se.bsnet.fukt.Mandos.Client"
462
CheckedOK = dbus.service.method(_interface)(checked_ok)
463
CheckedOK.__name__ = "CheckedOK"
465
# CheckerCompleted - signal
466
@dbus.service.signal(_interface, signature="nxs")
467
def CheckerCompleted(self, exitcode, waitstatus, command):
471
# CheckerStarted - signal
472
@dbus.service.signal(_interface, signature="s")
473
def CheckerStarted(self, command):
477
# GetAllProperties - method
478
@dbus.service.method(_interface, out_signature="a{sv}")
479
def GetAllProperties(self):
481
return dbus.Dictionary({
483
dbus.String(self.name, variant_level=1),
484
dbus.String("fingerprint"):
485
dbus.String(self.fingerprint, variant_level=1),
487
dbus.String(self.host, variant_level=1),
488
dbus.String("created"):
489
_datetime_to_dbus(self.created, variant_level=1),
490
dbus.String("last_enabled"):
491
(_datetime_to_dbus(self.last_enabled,
493
if self.last_enabled is not None
494
else dbus.Boolean(False, variant_level=1)),
495
dbus.String("enabled"):
496
dbus.Boolean(self.enabled, variant_level=1),
497
dbus.String("last_checked_ok"):
498
(_datetime_to_dbus(self.last_checked_ok,
500
if self.last_checked_ok is not None
501
else dbus.Boolean (False, variant_level=1)),
502
dbus.String("timeout"):
503
dbus.UInt64(self.timeout_milliseconds(),
505
dbus.String("interval"):
506
dbus.UInt64(self.interval_milliseconds(),
508
dbus.String("checker"):
509
dbus.String(self.checker_command,
511
dbus.String("checker_running"):
512
dbus.Boolean(self.checker is not None,
514
dbus.String("object_path"):
515
dbus.ObjectPath(self.dbus_object_path,
519
# IsStillValid - method
520
IsStillValid = (dbus.service.method(_interface, out_signature="b")
522
IsStillValid.__name__ = "IsStillValid"
524
# PropertyChanged - signal
525
@dbus.service.signal(_interface, signature="sv")
526
def PropertyChanged(self, property, value):
530
# SetChecker - method
531
@dbus.service.method(_interface, in_signature="s")
532
def SetChecker(self, checker):
533
"D-Bus setter method"
534
self.checker_command = checker
536
self.PropertyChanged(dbus.String(u"checker"),
537
dbus.String(self.checker_command,
541
@dbus.service.method(_interface, in_signature="s")
542
def SetHost(self, host):
543
"D-Bus setter method"
546
self.PropertyChanged(dbus.String(u"host"),
547
dbus.String(self.host, variant_level=1))
549
# SetInterval - method
550
@dbus.service.method(_interface, in_signature="t")
551
def SetInterval(self, milliseconds):
552
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
554
self.PropertyChanged(dbus.String(u"interval"),
555
(dbus.UInt64(self.interval_milliseconds(),
559
@dbus.service.method(_interface, in_signature="ay",
561
def SetSecret(self, secret):
562
"D-Bus setter method"
563
self.secret = str(secret)
565
# SetTimeout - method
566
@dbus.service.method(_interface, in_signature="t")
567
def SetTimeout(self, milliseconds):
568
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
570
self.PropertyChanged(dbus.String(u"timeout"),
571
(dbus.UInt64(self.timeout_milliseconds(),
575
Enable = dbus.service.method(_interface)(enable)
576
Enable.__name__ = "Enable"
578
# StartChecker - method
579
@dbus.service.method(_interface)
580
def StartChecker(self):
585
@dbus.service.method(_interface)
590
# StopChecker - method
591
StopChecker = dbus.service.method(_interface)(stop_checker)
592
StopChecker.__name__ = "StopChecker"
376
597
def peer_certificate(session):
377
598
"Return the peer's OpenPGP certificate as a bytestring"
378
599
# If not an OpenPGP certificate...
379
if gnutls.library.functions.gnutls_certificate_type_get\
380
(session._c_object) \
381
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
600
if (gnutls.library.functions
601
.gnutls_certificate_type_get(session._c_object)
602
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
382
603
# ...do the normal thing
383
604
return session.peer_certificate
384
list_size = ctypes.c_uint()
385
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
386
(session._c_object, ctypes.byref(list_size))
605
list_size = ctypes.c_uint(1)
606
cert_list = (gnutls.library.functions
607
.gnutls_certificate_get_peers
608
(session._c_object, ctypes.byref(list_size)))
609
if not bool(cert_list) and list_size.value != 0:
610
raise gnutls.errors.GNUTLSError("error getting peer"
387
612
if list_size.value == 0:
389
614
cert = cert_list[0]
393
618
def fingerprint(openpgp):
394
619
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
395
620
# New GnuTLS "datum" with the OpenPGP public key
396
datum = gnutls.library.types.gnutls_datum_t\
397
(ctypes.cast(ctypes.c_char_p(openpgp),
398
ctypes.POINTER(ctypes.c_ubyte)),
399
ctypes.c_uint(len(openpgp)))
621
datum = (gnutls.library.types
622
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
625
ctypes.c_uint(len(openpgp))))
400
626
# New empty GnuTLS certificate
401
627
crt = gnutls.library.types.gnutls_openpgp_crt_t()
402
gnutls.library.functions.gnutls_openpgp_crt_init\
628
(gnutls.library.functions
629
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
404
630
# Import the OpenPGP public key into the certificate
405
gnutls.library.functions.gnutls_openpgp_crt_import\
406
(crt, ctypes.byref(datum),
407
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
631
(gnutls.library.functions
632
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
633
gnutls.library.constants
634
.GNUTLS_OPENPGP_FMT_RAW))
635
# Verify the self signature in the key
636
crtverify = ctypes.c_uint()
637
(gnutls.library.functions
638
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
639
if crtverify.value != 0:
640
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
641
raise gnutls.errors.CertificateSecurityError("Verify failed")
408
642
# New buffer for the fingerprint
409
buffer = ctypes.create_string_buffer(20)
410
buffer_length = ctypes.c_size_t()
643
buf = ctypes.create_string_buffer(20)
644
buf_len = ctypes.c_size_t()
411
645
# Get the fingerprint from the certificate into the buffer
412
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
413
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
646
(gnutls.library.functions
647
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
648
ctypes.byref(buf_len)))
414
649
# Deinit the certificate
415
650
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
416
651
# Convert the buffer to a Python bytestring
417
fpr = ctypes.string_at(buffer, buffer_length.value)
652
fpr = ctypes.string_at(buf, buf_len.value)
418
653
# Convert the bytestring to hexadecimal notation
419
654
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
423
class tcp_handler(SocketServer.BaseRequestHandler, object):
658
class TCP_handler(SocketServer.BaseRequestHandler, object):
424
659
"""A TCP request handler class.
425
660
Instantiated by IPv6_TCPServer for each request to handle it.
426
661
Note: This will run in its own forked process."""
428
663
def handle(self):
429
664
logger.info(u"TCP connection from: %s",
430
unicode(self.client_address))
431
session = gnutls.connection.ClientSession\
432
(self.request, gnutls.connection.X509Credentials())
665
unicode(self.client_address))
666
session = (gnutls.connection
667
.ClientSession(self.request,
434
671
line = self.request.makefile().readline()
435
672
logger.debug(u"Protocol version: %r", line)
694
945
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
695
946
"servicename": "Mandos",
698
950
# Parse config file for server-global settings
699
951
server_config = ConfigParser.SafeConfigParser(server_defaults)
700
952
del server_defaults
701
953
server_config.read(os.path.join(options.configdir, "mandos.conf"))
702
server_section = "server"
703
954
# Convert the SafeConfigParser object to a dict
704
server_settings = dict(server_config.items(server_section))
705
# Use getboolean on the boolean config option
706
server_settings["debug"] = server_config.getboolean\
707
(server_section, "debug")
955
server_settings = server_config.defaults()
956
# Use the appropriate methods on the non-string config options
957
server_settings["debug"] = server_config.getboolean("DEFAULT",
959
server_settings["use_dbus"] = server_config.getboolean("DEFAULT",
961
if server_settings["port"]:
962
server_settings["port"] = server_config.getint("DEFAULT",
708
964
del server_config
710
966
# Override the settings from the config file with command line
711
967
# options, if set.
712
968
for option in ("interface", "address", "port", "debug",
713
"priority", "servicename", "configdir"):
969
"priority", "servicename", "configdir",
714
971
value = getattr(options, option)
715
972
if value is not None:
716
973
server_settings[option] = value
718
975
# Now we have our good server settings in "server_settings"
720
978
debug = server_settings["debug"]
979
use_dbus = server_settings["use_dbus"]
723
982
syslogger.setLevel(logging.WARNING)
724
983
console.setLevel(logging.WARNING)
726
985
if server_settings["servicename"] != "Mandos":
727
syslogger.setFormatter(logging.Formatter\
986
syslogger.setFormatter(logging.Formatter
728
987
('Mandos (%s): %%(levelname)s:'
730
989
% server_settings["servicename"]))
808
1119
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
809
1120
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1123
class MandosServer(dbus.service.Object):
1124
"""A D-Bus proxy object"""
1126
dbus.service.Object.__init__(self, bus, "/")
1127
_interface = u"se.bsnet.fukt.Mandos"
1129
@dbus.service.signal(_interface, signature="oa{sv}")
1130
def ClientAdded(self, objpath, properties):
1134
@dbus.service.signal(_interface, signature="os")
1135
def ClientRemoved(self, objpath, name):
1139
@dbus.service.method(_interface, out_signature="ao")
1140
def GetAllClients(self):
1142
return dbus.Array(c.dbus_object_path for c in clients)
1144
@dbus.service.method(_interface, out_signature="a{oa{sv}}")
1145
def GetAllClientsWithProperties(self):
1147
return dbus.Dictionary(
1148
((c.dbus_object_path, c.GetAllProperties())
1152
@dbus.service.method(_interface, in_signature="o")
1153
def RemoveClient(self, object_path):
1156
if c.dbus_object_path == object_path:
1158
# Don't signal anything except ClientRemoved
1162
self.ClientRemoved(object_path, c.name)
1168
mandos_server = MandosServer()
811
1170
for client in clients:
814
tcp_server = IPv6_TCPServer((server_settings["address"],
815
server_settings["port"]),
817
settings=server_settings,
1173
mandos_server.ClientAdded(client.dbus_object_path,
1174
client.GetAllProperties())
1178
tcp_server.server_activate()
819
1180
# Find out what port we got
820
1181
service.port = tcp_server.socket.getsockname()[1]
821
1182
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"