6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
# following functions: "AvahiService.add", "AvahiService.remove",
10
# "server_state_changed", "entry_group_state_changed", and some lines
9
# methods "add" and "remove" in the "AvahiService" class, the
10
# "server_state_changed" and "entry_group_state_changed" functions,
11
# and some lines in "main".
13
13
# Everything else is
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
14
# Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
16
16
# This program is free software: you can redistribute it and/or modify
17
17
# it under the terms of the GNU General Public License as published by
56
56
import logging.handlers
61
62
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.
76
68
logger = logging.Logger('mandos')
77
69
syslogger = logging.handlers.SysLogHandler\
78
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
70
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
79
72
syslogger.setFormatter(logging.Formatter\
80
('%(levelname)s: %(message)s'))
73
('Mandos: %(levelname)s: %(message)s'))
81
74
logger.addHandler(syslogger)
76
console = logging.StreamHandler()
77
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
79
logger.addHandler(console)
85
81
class AvahiError(Exception):
86
82
def __init__(self, value):
84
super(AvahiError, self).__init__()
89
86
return repr(self.value)
98
95
class AvahiService(object):
96
"""An Avahi (Zeroconf) service.
100
98
interface: integer; avahi.IF_UNSPEC or an interface index.
101
99
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
100
name: string; Example: 'Mandos'
101
type: string; Example: '_mandos._tcp'.
102
See <http://www.dns-sd.org/ServiceTypes.html>
103
port: integer; what port to announce
104
TXT: list of strings; TXT record for the service
105
domain: string; Domain to publish on, default to .local if empty.
106
host: string; Host to publish records for, default is localhost
107
max_renames: integer; maximum number of renames
108
rename_count: integer; counter so we only rename after collisions
109
a sensible number of times
114
111
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. """
112
servicetype = None, port = None, TXT = None, domain = "",
113
host = "", max_renames = 32768):
118
114
self.interface = interface
116
self.type = servicetype
126
122
self.domain = domain
128
124
self.rename_count = 0
125
self.max_renames = max_renames
129
126
def rename(self):
130
127
"""Derived from the Avahi example code"""
131
128
if self.rename_count >= self.max_renames:
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
129
logger.critical(u"No suitable Zeroconf service name found"
130
u" after %i retries, exiting.",
134
132
raise AvahiServiceError("Too many renames")
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
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))
139
141
self.rename_count += 1
151
153
avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
154
group.connect_to_signal('StateChanged',
153
155
entry_group_state_changed)
154
logger.debug(u"Adding service '%s' of type '%s' ...",
156
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
155
157
service.name, service.type)
156
158
group.AddService(
157
159
self.interface, # interface
175
177
fingerprint: string (40 or 32 hexadecimal digits); used to
176
178
uniquely identify the client
177
179
secret: bytestring; sent verbatim (over TLS) to client
178
fqdn: string (FQDN); available for use by the checker command
180
host: string; available for use by the checker command
179
181
created: datetime.datetime(); object creation, not client host
180
182
last_checked_ok: datetime.datetime() or None if not yet checked OK
181
183
timeout: datetime.timedelta(); How long from last_checked_ok
221
223
interval = property(lambda self: self._interval,
223
225
del _set_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.."""
226
def __init__(self, name = None, stop_hook=None, config=None):
227
"""Note: the 'checker' key in 'config' sets the
228
'checker_command' attribute and *not* the 'checker'
230
233
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"")
234
# Uppercase and remove spaces from fingerprint for later
235
# comparison purposes with return value from the fingerprint()
237
self.fingerprint = config["fingerprint"].upper()\
235
239
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
self.secret = secret.decode(u"base64")
240
self.secret = sf.read()
240
if "secret" in config:
241
self.secret = config["secret"].decode(u"base64")
242
elif "secfile" in config:
243
secfile = open(os.path.expanduser(os.path.expandvars
244
(config["secfile"])))
245
self.secret = secfile.read()
243
248
raise TypeError(u"No secret or secfile for client %s"
250
self.host = config.get("host", "")
246
251
self.created = datetime.datetime.now()
247
252
self.last_checked_ok = None
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
253
self.timeout = string_to_delta(config["timeout"])
254
self.interval = string_to_delta(config["interval"])
250
255
self.stop_hook = stop_hook
251
256
self.checker = None
252
257
self.checker_initiator_tag = None
253
258
self.stop_initiator_tag = None
254
259
self.checker_callback_tag = None
255
self.check_command = checker
260
self.check_command = config["checker"]
257
262
"""Start this client's checker and timeout hooks"""
258
263
# Schedule a new checker to be started an 'interval' from now,
338
343
u' %s', self.check_command, error)
339
344
return True # Try again later
341
logger.debug(u"Starting checker %r for %s",
346
logger.info(u"Starting checker %r for %s",
348
# We don't need to redirect stdout and stderr, since
349
# in normal mode, that is already done by daemon(),
350
# and in debug mode we don't want to. (Stdin is
351
# always replaced by /dev/null.)
343
352
self.checker = subprocess.Popen(command,
345
354
shell=True, cwd="/")
346
355
self.checker_callback_tag = gobject.child_watch_add\
347
356
(self.checker.pid,
348
357
self.checker_callback)
349
except subprocess.OSError, error:
358
except OSError, error:
350
359
logger.error(u"Failed to start subprocess: %s",
352
361
# Re-run this periodically if run by gobject.timeout_add
397
406
def fingerprint(openpgp):
398
407
"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
408
# New GnuTLS "datum" with the OpenPGP public key
404
409
datum = gnutls.library.types.gnutls_datum_t\
405
410
(ctypes.cast(ctypes.c_char_p(openpgp),
406
411
ctypes.POINTER(ctypes.c_ubyte)),
407
412
ctypes.c_uint(len(openpgp)))
413
# New empty GnuTLS certificate
414
crt = gnutls.library.types.gnutls_openpgp_crt_t()
415
gnutls.library.functions.gnutls_openpgp_crt_init\
408
417
# 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)
418
gnutls.library.functions.gnutls_openpgp_crt_import\
419
(crt, ctypes.byref(datum),
420
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
421
# Verify the self signature in the key
422
crtverify = ctypes.c_uint()
423
gnutls.library.functions.gnutls_openpgp_crt_verify_self\
424
(crt, 0, ctypes.byref(crtverify))
425
if crtverify.value != 0:
426
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
427
raise gnutls.errors.CertificateSecurityError("Verify failed")
413
428
# New buffer for the fingerprint
414
buffer = ctypes.create_string_buffer(20)
415
buffer_length = ctypes.c_size_t()
429
buf = ctypes.create_string_buffer(20)
430
buf_len = ctypes.c_size_t()
416
431
# Get the fingerprint from the certificate into the buffer
417
432
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
418
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
433
(crt, ctypes.byref(buf), ctypes.byref(buf_len))
419
434
# Deinit the certificate
420
435
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
421
436
# Convert the buffer to a Python bytestring
422
fpr = ctypes.string_at(buffer, buffer_length.value)
437
fpr = ctypes.string_at(buf, buf_len.value)
423
438
# Convert the bytestring to hexadecimal notation
424
439
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
443
class TCP_handler(SocketServer.BaseRequestHandler, object):
429
444
"""A TCP request handler class.
430
445
Instantiated by IPv6_TCPServer for each request to handle it.
431
446
Note: This will run in its own forked process."""
433
448
def handle(self):
434
logger.debug(u"TCP connection from: %s",
449
logger.info(u"TCP connection from: %s",
435
450
unicode(self.client_address))
436
451
session = gnutls.connection.ClientSession\
437
452
(self.request, gnutls.connection.X509Credentials())
458
473
if self.server.settings["priority"]:
459
474
priority = self.server.settings["priority"]
460
475
gnutls.library.functions.gnutls_priority_set_direct\
461
(session._c_object, priority, None);
476
(session._c_object, priority, None)
464
479
session.handshake()
465
480
except gnutls.errors.GNUTLSError, error:
466
logger.debug(u"Handshake failed: %s", error)
481
logger.warning(u"Handshake failed: %s", error)
467
482
# Do not run session.bye() here: the session is not
468
483
# established. Just abandon the request.
471
486
fpr = fingerprint(peer_certificate(session))
472
487
except (TypeError, gnutls.errors.GNUTLSError), error:
473
logger.debug(u"Bad certificate: %s", error)
488
logger.warning(u"Bad certificate: %s", error)
476
491
logger.debug(u"Fingerprint: %s", fpr)
483
logger.debug(u"Client not found for fingerprint: %s", fpr)
498
logger.warning(u"Client not found for fingerprint: %s",
486
502
# Have to check if client.still_valid(), since it is possible
487
503
# that the client timed out while establishing the GnuTLS
489
505
if not client.still_valid():
490
logger.debug(u"Client %(name)s is invalid", vars(client))
506
logger.warning(u"Client %(name)s is invalid",
528
547
self.settings["interface"])
529
548
except socket.error, error:
530
549
if error[0] == errno.EPERM:
531
logger.warning(u"No permission to"
532
u" bind to interface %s",
533
self.settings["interface"])
550
logger.error(u"No permission to"
551
u" bind to interface %s",
552
self.settings["interface"])
536
555
# Only bind(2) the socket if we really need to.
539
558
in6addr_any = "::"
540
559
self.server_address = (in6addr_any,
541
560
self.server_address[1])
542
elif self.server_address[1] is None:
561
elif not self.server_address[1]:
543
562
self.server_address = (self.server_address[0],
545
return super(type(self), self).server_bind()
564
# if self.settings["interface"]:
565
# self.server_address = (self.server_address[0],
571
return super(IPv6_TCPServer, self).server_bind()
572
def server_activate(self):
574
return super(IPv6_TCPServer, self).server_activate()
548
579
def string_to_delta(interval):
558
589
datetime.timedelta(1)
559
590
>>> string_to_delta(u'1w')
560
591
datetime.timedelta(7)
592
>>> string_to_delta('5m 30s')
593
datetime.timedelta(0, 330)
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)
595
timevalue = datetime.timedelta(0)
596
for s in interval.split():
598
suffix = unicode(s[-1])
601
delta = datetime.timedelta(value)
603
delta = datetime.timedelta(0, value)
605
delta = datetime.timedelta(0, 0, 0, 0, value)
607
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
609
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
612
except (ValueError, IndexError):
577
except (ValueError, IndexError):
582
618
def server_state_changed(state):
583
619
"""Derived from the Avahi example code"""
584
620
if state == avahi.SERVER_COLLISION:
585
logger.warning(u"Server name collision")
621
logger.error(u"Zeroconf server name collision")
587
623
elif state == avahi.SERVER_RUNNING:
591
627
def entry_group_state_changed(state, error):
592
628
"""Derived from the Avahi example code"""
593
logger.debug(u"state change: %i", state)
629
logger.debug(u"Avahi state change: %i", state)
595
631
if state == avahi.ENTRY_GROUP_ESTABLISHED:
596
logger.debug(u"Service established.")
632
logger.debug(u"Zeroconf service established.")
597
633
elif state == avahi.ENTRY_GROUP_COLLISION:
598
logger.warning(u"Service name collision.")
634
logger.warning(u"Zeroconf service name collision.")
600
636
elif state == avahi.ENTRY_GROUP_FAILURE:
601
logger.critical(u"Error in group state changed %s",
637
logger.critical(u"Avahi: Error in group state changed %s",
603
639
raise AvahiGroupError("State changed: %s", str(error))
661
694
help="Port number to receive requests on")
662
695
parser.add_option("--check", action="store_true", default=False,
663
696
help="Run self-test")
664
parser.add_option("--debug", action="store_true", default=False,
697
parser.add_option("--debug", action="store_true",
665
698
help="Debug mode; run in foreground and log to"
667
700
parser.add_option("--priority", type="string", help="GnuTLS"
692
725
# Parse config file for server-global settings
693
726
server_config = ConfigParser.SafeConfigParser(server_defaults)
694
727
del server_defaults
695
server_config.read(os.path.join(options.configdir, "server.conf"))
696
server_section = "server"
728
server_config.read(os.path.join(options.configdir, "mandos.conf"))
697
729
# Convert the SafeConfigParser object to a dict
698
server_settings = dict(server_config.items(server_section))
730
server_settings = server_config.defaults()
699
731
# Use getboolean on the boolean config option
700
732
server_settings["debug"] = server_config.getboolean\
701
(server_section, "debug")
702
734
del server_config
704
736
# Override the settings from the config file with command line
712
744
# Now we have our good server settings in "server_settings"
746
debug = server_settings["debug"]
749
syslogger.setLevel(logging.WARNING)
750
console.setLevel(logging.WARNING)
752
if server_settings["servicename"] != "Mandos":
753
syslogger.setFormatter(logging.Formatter\
754
('Mandos (%s): %%(levelname)s:'
756
% server_settings["servicename"]))
714
758
# Parse config file with clients
715
759
client_defaults = { "timeout": "1h",
716
760
"interval": "5m",
717
"checker": "fping -q -- %%(fqdn)s",
761
"checker": "fping -q -- %(host)s",
719
764
client_config = ConfigParser.SafeConfigParser(client_defaults)
720
765
client_config.read(os.path.join(server_settings["configdir"],
769
tcp_server = IPv6_TCPServer((server_settings["address"],
770
server_settings["port"]),
772
settings=server_settings,
774
pidfilename = "/var/run/mandos.pid"
776
pidfile = open(pidfilename, "w")
777
except IOError, error:
778
logger.error("Could not open file %r", pidfilename)
783
uid = pwd.getpwnam("mandos").pw_uid
786
uid = pwd.getpwnam("nobody").pw_uid
790
gid = pwd.getpwnam("mandos").pw_gid
793
gid = pwd.getpwnam("nogroup").pw_gid
799
except OSError, error:
800
if error[0] != errno.EPERM:
724
804
service = AvahiService(name = server_settings["servicename"],
725
type = "_mandos._tcp", );
805
servicetype = "_mandos._tcp", )
726
806
if server_settings["interface"]:
727
service.interface = if_nametoindex(server_settings["interface"])
807
service.interface = if_nametoindex\
808
(server_settings["interface"])
733
814
DBusGMainLoop(set_as_default=True )
734
815
main_loop = gobject.MainLoop()
735
816
bus = dbus.SystemBus()
736
server = dbus.Interface(
737
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
738
avahi.DBUS_INTERFACE_SERVER )
817
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
818
avahi.DBUS_PATH_SERVER),
819
avahi.DBUS_INTERFACE_SERVER)
739
820
# End of Avahi example code
741
debug = server_settings["debug"]
744
console = logging.StreamHandler()
745
# console.setLevel(logging.DEBUG)
746
console.setFormatter(logging.Formatter\
747
('%(levelname)s: %(message)s'))
748
logger.addHandler(console)
752
822
def remove_from_clients(client):
753
823
clients.remove(client)
755
logger.debug(u"No clients left, exiting")
825
logger.critical(u"No clients left, exiting")
758
clients.update(Set(Client(name=section,
828
clients.update(Set(Client(name = section,
759
829
stop_hook = remove_from_clients,
760
**(dict(client_config\
831
= dict(client_config.items(section)))
762
832
for section in client_config.sections()))
834
logger.critical(u"No clients defined")
838
# Redirect stdin so all checkers get /dev/null
839
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
840
os.dup2(null, sys.stdin.fileno())
845
logger.removeHandler(console)
846
# Close all input and output, do double fork, etc.
851
pidfile.write(str(pid) + "\n")
855
logger.error(u"Could not write to file %r with PID %d",
858
# "pidfile" was never created
768
863
"Cleanup function; run on exit"
788
883
for client in clients:
791
tcp_server = IPv6_TCPServer((server_settings["address"],
792
server_settings["port"]),
794
settings=server_settings,
887
tcp_server.server_activate()
796
889
# Find out what port we got
797
890
service.port = tcp_server.socket.getsockname()[1]
798
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
799
u" scope_id %d" % tcp_server.socket.getsockname())
891
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
892
u" scope_id %d" % tcp_server.socket.getsockname())
801
894
#service.interface = tcp_server.socket.getsockname()[3]