57
56
import logging.handlers
59
from contextlib import closing
65
61
from dbus.mainloop.glib import DBusGMainLoop
64
# Brief description of the operation of this program:
66
# This server announces itself as a Zeroconf service. Connecting
67
# clients use the TLS protocol, with the unusual quirk that this
68
# server program acts as a TLS "client" while a connecting client acts
69
# as a TLS "server". The client (acting as a TLS "server") must
70
# supply an OpenPGP certificate, and the fingerprint of this
71
# certificate is used by this server to look up (in a list read from a
72
# file at start time) which binary blob to give the client. No other
73
# authentication or authorization is done by this server.
71
76
logger = logging.Logger('mandos')
72
syslogger = (logging.handlers.SysLogHandler
73
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
74
address = "/dev/log"))
75
syslogger.setFormatter(logging.Formatter
76
('Mandos: %(levelname)s: %(message)s'))
77
syslogger = logging.handlers.SysLogHandler\
78
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
79
syslogger.setFormatter(logging.Formatter\
80
('%(levelname)s: %(message)s'))
77
81
logger.addHandler(syslogger)
79
console = logging.StreamHandler()
80
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
82
logger.addHandler(console)
84
85
class AvahiError(Exception):
85
86
def __init__(self, value):
87
super(AvahiError, self).__init__()
89
89
return repr(self.value)
112
112
a sensible number of times
114
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
servicetype = None, port = None, TXT = None,
116
domain = "", host = "", max_renames = 32768):
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
117
self.interface = interface
119
self.type = servicetype
121
self.TXT = TXT if TXT is not None else []
122
125
self.domain = domain
124
127
self.rename_count = 0
125
self.max_renames = max_renames
126
128
def rename(self):
127
129
"""Derived from the Avahi example code"""
128
130
if self.rename_count >= self.max_renames:
129
logger.critical(u"No suitable Zeroconf service name found"
130
u" after %i retries, exiting.",
131
logger.critical(u"No suitable service name found after %i"
132
u" retries, exiting.", rename_count)
132
133
raise AvahiServiceError("Too many renames")
133
self.name = server.GetAlternativeServiceName(self.name)
134
logger.info(u"Changing Zeroconf service name to %r ...",
136
syslogger.setFormatter(logging.Formatter
137
('Mandos (%s): %%(levelname)s:'
138
' %%(message)s' % self.name))
134
name = server.GetAlternativeServiceName(name)
135
logger.error(u"Changing name to %r ...", name)
141
138
self.rename_count += 1
170
167
# End of Avahi example code
173
class Client(dbus.service.Object):
170
class Client(object):
174
171
"""A representation of a client host served by this server.
176
173
name: string; from the config file, used in log messages
177
174
fingerprint: string (40 or 32 hexadecimal digits); used to
178
175
uniquely identify the client
179
176
secret: bytestring; sent verbatim (over TLS) to client
180
host: string; available for use by the checker command
181
created: datetime.datetime(); (UTC) object creation
182
started: datetime.datetime(); (UTC) last started
183
last_checked_ok: datetime.datetime(); (UTC) or None
177
fqdn: string (FQDN); available for use by the checker command
178
created: datetime.datetime(); object creation, not client host
179
last_checked_ok: datetime.datetime() or None if not yet checked OK
184
180
timeout: datetime.timedelta(); How long from last_checked_ok
185
181
until this client is invalid
186
182
interval: datetime.timedelta(); How often to start a new checker
224
218
+ (self.interval.microseconds
227
self.IntervalChanged(self._interval_milliseconds)
228
interval = property(lambda self: self._interval, _set_interval)
220
interval = property(lambda self: self._interval,
229
222
del _set_interval
231
def __init__(self, name = None, stop_hook=None, config=None):
223
def __init__(self, name = None, stop_hook=None, config={}):
232
224
"""Note: the 'checker' key in 'config' sets the
233
225
'checker_command' attribute and *not* the 'checker'
235
dbus.service.Object.__init__(self, bus,
237
% name.replace(".", "_"))
241
228
logger.debug(u"Creating client %r", self.name)
242
229
# Uppercase and remove spaces from fingerprint for later
243
230
# comparison purposes with return value from the fingerprint()
245
self.fingerprint = (config["fingerprint"].upper()
232
self.fingerprint = config["fingerprint"].upper()\
247
234
logger.debug(u" Fingerprint: %s", self.fingerprint)
248
235
if "secret" in config:
249
236
self.secret = config["secret"].decode(u"base64")
250
237
elif "secfile" in config:
251
with closing(open(os.path.expanduser
253
(config["secfile"])))) as secfile:
254
self.secret = secfile.read()
238
sf = open(config["secfile"])
239
self.secret = sf.read()
256
242
raise TypeError(u"No secret or secfile for client %s"
258
self.host = config.get("host", "")
259
self.created = datetime.datetime.utcnow()
244
self.fqdn = config.get("fqdn", "")
245
self.created = datetime.datetime.now()
261
246
self.last_checked_ok = None
262
247
self.timeout = string_to_delta(config["timeout"])
263
248
self.interval = string_to_delta(config["interval"])
267
252
self.stop_initiator_tag = None
268
253
self.checker_callback_tag = None
269
254
self.check_command = config["checker"]
272
256
"""Start this client's checker and timeout hooks"""
273
self.started = datetime.datetime.utcnow()
274
257
# Schedule a new checker to be started an 'interval' from now,
275
258
# and every interval from then on.
276
self.checker_initiator_tag = (gobject.timeout_add
277
(self._interval_milliseconds,
259
self.checker_initiator_tag = gobject.timeout_add\
260
(self._interval_milliseconds,
279
262
# Also start a new checker *right now*.
280
263
self.start_checker()
281
264
# Schedule a stop() when 'timeout' has passed
282
self.stop_initiator_tag = (gobject.timeout_add
283
(self._timeout_milliseconds,
286
self.StateChanged(True)
265
self.stop_initiator_tag = gobject.timeout_add\
266
(self._timeout_milliseconds,
289
"""Stop this client."""
290
if getattr(self, "started", None) is not None:
270
The possibility that a client might be restarted is left open,
271
but not currently used."""
272
# If this client doesn't have a secret, it is already stopped.
291
274
logger.info(u"Stopping client %s", self.name)
294
278
if getattr(self, "stop_initiator_tag", False):
300
284
self.stop_checker()
301
285
if self.stop_hook:
302
286
self.stop_hook(self)
305
self.StateChanged(False)
306
287
# Do not run this again if called by a gobject.timeout_add
309
289
def __del__(self):
310
290
self.stop_hook = None
313
292
def checker_callback(self, pid, condition):
314
293
"""The checker has completed, so take appropriate actions."""
294
now = datetime.datetime.now()
315
295
self.checker_callback_tag = None
316
296
self.checker = None
317
if (os.WIFEXITED(condition)
318
and (os.WEXITSTATUS(condition) == 0)):
297
if os.WIFEXITED(condition) \
298
and (os.WEXITSTATUS(condition) == 0):
319
299
logger.info(u"Checker for %(name)s succeeded",
322
self.CheckerCompleted(True)
301
self.last_checked_ok = now
302
gobject.source_remove(self.stop_initiator_tag)
303
self.stop_initiator_tag = gobject.timeout_add\
304
(self._timeout_milliseconds,
324
306
elif not os.WIFEXITED(condition):
325
307
logger.warning(u"Checker for %(name)s crashed?",
328
self.CheckerCompleted(False)
330
310
logger.info(u"Checker for %(name)s failed",
333
self.CheckerCompleted(False)
335
def bump_timeout(self):
336
"""Bump up the timeout for this client.
337
This should only be called when the client has been seen,
340
self.last_checked_ok = datetime.datetime.utcnow()
341
gobject.source_remove(self.stop_initiator_tag)
342
self.stop_initiator_tag = (gobject.timeout_add
343
(self._timeout_milliseconds,
346
312
def start_checker(self):
347
313
"""Start a new checker subprocess if one is not running.
348
314
If a checker already exists, leave it running and do
408
367
if error.errno != errno.ESRCH: # No such process
410
369
self.checker = None
412
370
def still_valid(self):
413
371
"""Has the timeout not yet passed for this client?"""
416
now = datetime.datetime.utcnow()
372
now = datetime.datetime.now()
417
373
if self.last_checked_ok is None:
418
374
return now < (self.created + self.timeout)
420
376
return now < (self.last_checked_ok + self.timeout)
422
## D-Bus methods & signals
423
_interface = u"org.mandos_system.Mandos.Client"
425
def _datetime_to_dbus_struct(dt):
426
return dbus.Struct(dt.year, dt.month, dt.day, dt.hour,
427
dt.minute, dt.second, dt.microsecond,
430
# BumpTimeout - method
431
BumpTimeout = dbus.service.method(_interface)(bump_timeout)
432
BumpTimeout.__name__ = "BumpTimeout"
434
# IntervalChanged - signal
435
@dbus.service.signal(_interface, signature="t")
436
def IntervalChanged(self, t):
440
# CheckerCompleted - signal
441
@dbus.service.signal(_interface, signature="b")
442
def CheckerCompleted(self, success):
446
# CheckerIsRunning - method
447
@dbus.service.method(_interface, out_signature="b")
448
def CheckerIsRunning(self):
449
"D-Bus getter method"
450
return self.checker is not None
452
# CheckerStarted - signal
453
@dbus.service.signal(_interface, signature="s")
454
def CheckerStarted(self, command):
458
# GetChecker - method
459
@dbus.service.method(_interface, out_signature="s")
460
def GetChecker(self):
461
"D-Bus getter method"
462
return self.checker_command
464
# GetCreated - method
465
@dbus.service.method(_interface, out_signature="(nyyyyyu)")
466
def GetCreated(self):
467
"D-Bus getter method"
468
return datetime_to_dbus_struct(self.created)
470
# GetFingerprint - method
471
@dbus.service.method(_interface, out_signature="s")
472
def GetFingerprint(self):
473
"D-Bus getter method"
474
return self.fingerprint
477
@dbus.service.method(_interface, out_signature="s")
479
"D-Bus getter method"
482
# GetInterval - method
483
@dbus.service.method(_interface, out_signature="t")
484
def GetInterval(self):
485
"D-Bus getter method"
486
return self._interval_milliseconds
489
@dbus.service.method(_interface, out_signature="s")
491
"D-Bus getter method"
494
# GetStarted - method
495
@dbus.service.method(_interface, out_signature="(nyyyyyu)")
496
def GetStarted(self):
497
"D-Bus getter method"
498
if self.started is not None:
499
return datetime_to_dbus_struct(self.started)
501
return dbus.Struct(0, 0, 0, 0, 0, 0, 0,
504
# GetTimeout - method
505
@dbus.service.method(_interface, out_signature="t")
506
def GetTimeout(self):
507
"D-Bus getter method"
508
return self._timeout_milliseconds
510
# SetChecker - method
511
@dbus.service.method(_interface, in_signature="s")
512
def SetChecker(self, checker):
513
"D-Bus setter method"
514
self.checker_command = checker
517
@dbus.service.method(_interface, in_signature="s")
518
def SetHost(self, host):
519
"D-Bus setter method"
522
# SetInterval - method
523
@dbus.service.method(_interface, in_signature="t")
524
def SetInterval(self, milliseconds):
525
self.interval = datetime.timdeelta(0, 0, 0, milliseconds)
527
# SetTimeout - method
528
@dbus.service.method(_interface, in_signature="t")
529
def SetTimeout(self, milliseconds):
530
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
533
@dbus.service.method(_interface, in_signature="ay",
535
def SetSecret(self, secret):
536
"D-Bus setter method"
537
self.secret = str(secret)
540
Start = dbus.service.method(_interface)(start)
541
Start.__name__ = "Start"
543
# StartChecker - method
544
StartChecker = dbus.service.method(_interface)(start_checker)
545
StartChecker.__name__ = "StartChecker"
547
# StateChanged - signal
548
@dbus.service.signal(_interface, signature="b")
549
def StateChanged(self, started):
553
# StillValid - method
554
StillValid = (dbus.service.method(_interface, out_signature="b")
556
StillValid.__name__ = "StillValid"
559
Stop = dbus.service.method(_interface)(stop)
560
Stop.__name__ = "Stop"
562
# StopChecker - method
563
StopChecker = dbus.service.method(_interface)(stop_checker)
564
StopChecker.__name__ = "StopChecker"
566
# TimeoutChanged - signal
567
@dbus.service.signal(_interface, signature="t")
568
def TimeoutChanged(self, t):
572
del _datetime_to_dbus_struct
576
379
def peer_certificate(session):
577
380
"Return the peer's OpenPGP certificate as a bytestring"
578
381
# If not an OpenPGP certificate...
579
if (gnutls.library.functions
580
.gnutls_certificate_type_get(session._c_object)
581
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
382
if gnutls.library.functions.gnutls_certificate_type_get\
383
(session._c_object) \
384
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
582
385
# ...do the normal thing
583
386
return session.peer_certificate
584
387
list_size = ctypes.c_uint()
585
cert_list = (gnutls.library.functions
586
.gnutls_certificate_get_peers
587
(session._c_object, ctypes.byref(list_size)))
388
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
389
(session._c_object, ctypes.byref(list_size))
588
390
if list_size.value == 0:
590
392
cert = cert_list[0]
594
396
def fingerprint(openpgp):
595
397
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
596
398
# New GnuTLS "datum" with the OpenPGP public key
597
datum = (gnutls.library.types
598
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
601
ctypes.c_uint(len(openpgp))))
399
datum = gnutls.library.types.gnutls_datum_t\
400
(ctypes.cast(ctypes.c_char_p(openpgp),
401
ctypes.POINTER(ctypes.c_ubyte)),
402
ctypes.c_uint(len(openpgp)))
602
403
# New empty GnuTLS certificate
603
404
crt = gnutls.library.types.gnutls_openpgp_crt_t()
604
(gnutls.library.functions
605
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
405
gnutls.library.functions.gnutls_openpgp_crt_init\
606
407
# Import the OpenPGP public key into the certificate
607
(gnutls.library.functions
608
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
609
gnutls.library.constants
610
.GNUTLS_OPENPGP_FMT_RAW))
611
# Verify the self signature in the key
612
crtverify = ctypes.c_uint()
613
(gnutls.library.functions
614
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
615
if crtverify.value != 0:
616
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
617
raise gnutls.errors.CertificateSecurityError("Verify failed")
408
gnutls.library.functions.gnutls_openpgp_crt_import\
409
(crt, ctypes.byref(datum),
410
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
618
411
# New buffer for the fingerprint
619
buf = ctypes.create_string_buffer(20)
620
buf_len = ctypes.c_size_t()
412
buffer = ctypes.create_string_buffer(20)
413
buffer_length = ctypes.c_size_t()
621
414
# Get the fingerprint from the certificate into the buffer
622
(gnutls.library.functions
623
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
624
ctypes.byref(buf_len)))
415
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
416
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
625
417
# Deinit the certificate
626
418
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
627
419
# Convert the buffer to a Python bytestring
628
fpr = ctypes.string_at(buf, buf_len.value)
420
fpr = ctypes.string_at(buffer, buffer_length.value)
629
421
# Convert the bytestring to hexadecimal notation
630
422
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
634
class TCP_handler(SocketServer.BaseRequestHandler, object):
426
class tcp_handler(SocketServer.BaseRequestHandler, object):
635
427
"""A TCP request handler class.
636
428
Instantiated by IPv6_TCPServer for each request to handle it.
637
429
Note: This will run in its own forked process."""
639
431
def handle(self):
640
432
logger.info(u"TCP connection from: %s",
641
unicode(self.client_address))
642
session = (gnutls.connection
643
.ClientSession(self.request,
433
unicode(self.client_address))
434
session = gnutls.connection.ClientSession\
435
(self.request, gnutls.connection.X509Credentials())
647
437
line = self.request.makefile().readline()
648
438
logger.debug(u"Protocol version: %r", line)
783
558
datetime.timedelta(1)
784
559
>>> string_to_delta(u'1w')
785
560
datetime.timedelta(7)
786
>>> string_to_delta('5m 30s')
787
datetime.timedelta(0, 330)
789
timevalue = datetime.timedelta(0)
790
for s in interval.split():
792
suffix = unicode(s[-1])
795
delta = datetime.timedelta(value)
797
delta = datetime.timedelta(0, value)
799
delta = datetime.timedelta(0, 0, 0, 0, value)
801
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
803
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
806
except (ValueError, IndexError):
563
suffix=unicode(interval[-1])
564
value=int(interval[:-1])
566
delta = datetime.timedelta(value)
568
delta = datetime.timedelta(0, value)
570
delta = datetime.timedelta(0, 0, 0, 0, value)
572
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
574
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
577
except (ValueError, IndexError):
812
582
def server_state_changed(state):
813
583
"""Derived from the Avahi example code"""
814
584
if state == avahi.SERVER_COLLISION:
815
logger.error(u"Zeroconf server name collision")
585
logger.error(u"Server name collision")
817
587
elif state == avahi.SERVER_RUNNING:
847
618
def if_nametoindex(interface):
848
619
"Get an interface index the hard way, i.e. using fcntl()"
849
620
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
850
with closing(socket.socket()) as s:
851
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
852
struct.pack("16s16x", interface))
622
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
623
struct.pack("16s16x", interface))
853
625
interface_index = struct.unpack("I", ifreq[16:20])[0]
854
626
return interface_index
855
627
return if_nametoindex(interface)
858
def daemon(nochdir = False, noclose = False):
630
def daemon(nochdir, noclose):
859
631
"""See daemon(3). Standard BSD Unix function.
860
632
This should really exist as os.daemon, but it doesn't (yet)."""
938
712
# Now we have our good server settings in "server_settings"
940
debug = server_settings["debug"]
943
syslogger.setLevel(logging.WARNING)
944
console.setLevel(logging.WARNING)
946
if server_settings["servicename"] != "Mandos":
947
syslogger.setFormatter(logging.Formatter
948
('Mandos (%s): %%(levelname)s:'
950
% server_settings["servicename"]))
952
714
# Parse config file with clients
953
715
client_defaults = { "timeout": "1h",
954
716
"interval": "5m",
955
"checker": "fping -q -- %(host)s",
717
"checker": "fping -q -- %%(fqdn)s",
958
719
client_config = ConfigParser.SafeConfigParser(client_defaults)
959
720
client_config.read(os.path.join(server_settings["configdir"],
963
tcp_server = IPv6_TCPServer((server_settings["address"],
964
server_settings["port"]),
966
settings=server_settings,
968
pidfilename = "/var/run/mandos.pid"
970
pidfile = open(pidfilename, "w")
971
except IOError, error:
972
logger.error("Could not open file %r", pidfilename)
977
uid = pwd.getpwnam("mandos").pw_uid
980
uid = pwd.getpwnam("nobody").pw_uid
984
gid = pwd.getpwnam("mandos").pw_gid
987
gid = pwd.getpwnam("nogroup").pw_gid
993
except OSError, error:
994
if error[0] != errno.EPERM:
998
724
service = AvahiService(name = server_settings["servicename"],
999
servicetype = "_mandos._tcp", )
725
type = "_mandos._tcp", );
1000
726
if server_settings["interface"]:
1001
service.interface = (if_nametoindex
1002
(server_settings["interface"]))
727
service.interface = if_nametoindex(server_settings["interface"])
1004
729
global main_loop