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
# 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".
9
# following functions: "AvahiService.add", "AvahiService.remove",
10
# "server_state_changed", "entry_group_state_changed", and some lines
13
13
# Everything else is
14
# Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
14
# Copyright © 2007-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
24
24
# GNU General Public License for more details.
26
26
# You should have received a copy of the GNU General Public License
27
# along with this program. If not, see
28
# <http://www.gnu.org/licenses/>.
27
# along with this program. If not, see <http://www.gnu.org/licenses/>.
30
29
# Contact the authors at <mandos@fukt.bsnet.se>.
56
56
import logging.handlers
62
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.
68
76
logger = logging.Logger('mandos')
69
77
syslogger = logging.handlers.SysLogHandler\
70
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
78
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
72
79
syslogger.setFormatter(logging.Formatter\
73
('Mandos: %(levelname)s: %(message)s'))
80
('%(levelname)s: %(message)s'))
74
81
logger.addHandler(syslogger)
76
console = logging.StreamHandler()
77
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
79
logger.addHandler(console)
81
85
class AvahiError(Exception):
82
86
def __init__(self, value):
84
super(AvahiError, self).__init__()
86
89
return repr(self.value)
95
98
class AvahiService(object):
96
"""An Avahi (Zeroconf) service.
98
100
interface: integer; avahi.IF_UNSPEC or an interface index.
99
101
Used to optionally bind to the specified interface.
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
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
111
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
112
servicetype = None, port = None, TXT = None, domain = "",
113
host = "", max_renames = 32768):
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
114
118
self.interface = interface
116
self.type = servicetype
122
126
self.domain = domain
124
128
self.rename_count = 0
125
self.max_renames = max_renames
126
129
def rename(self):
127
130
"""Derived from the Avahi example code"""
128
131
if self.rename_count >= self.max_renames:
129
logger.critical(u"No suitable Zeroconf service name found"
130
u" after %i retries, exiting.",
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
132
134
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))
135
name = server.GetAlternativeServiceName(name)
136
logger.error(u"Changing name to %r ...", name)
141
139
self.rename_count += 1
153
151
avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
152
group.connect_to_signal('StateChanged',
155
153
entry_group_state_changed)
156
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
154
logger.debug(u"Adding service '%s' of type '%s' ...",
157
155
service.name, service.type)
158
156
group.AddService(
159
157
self.interface, # interface
177
175
fingerprint: string (40 or 32 hexadecimal digits); used to
178
176
uniquely identify the client
179
177
secret: bytestring; sent verbatim (over TLS) to client
180
host: string; available for use by the checker command
178
fqdn: string (FQDN); available for use by the checker command
181
179
created: datetime.datetime(); object creation, not client host
182
180
last_checked_ok: datetime.datetime() or None if not yet checked OK
183
181
timeout: datetime.timedelta(); How long from last_checked_ok
223
221
interval = property(lambda self: self._interval,
225
223
del _set_interval
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'
224
def __init__(self, name = None, stop_hook=None, config={}):
225
"""Note: the 'checker' argument sets the 'checker_command'
226
attribute and not the 'checker' attribute.."""
233
228
logger.debug(u"Creating client %r", self.name)
234
# Uppercase and remove spaces from fingerprint for later
235
# comparison purposes with return value from the fingerprint()
229
# Uppercase and remove spaces from fingerprint
230
# for later comparison purposes with return value of
231
# the fingerprint() function
237
232
self.fingerprint = config["fingerprint"].upper()\
238
233
.replace(u" ", u"")
239
234
logger.debug(u" Fingerprint: %s", self.fingerprint)
240
235
if "secret" in config:
241
236
self.secret = config["secret"].decode(u"base64")
242
237
elif "secfile" in config:
243
secfile = open(os.path.expanduser(os.path.expandvars
244
(config["secfile"])))
245
self.secret = secfile.read()
238
sf = open(config["secfile"])
239
self.secret = sf.read()
248
242
raise TypeError(u"No secret or secfile for client %s"
250
self.host = config.get("host", "")
244
self.fqdn = config.get("fqdn", "")
251
245
self.created = datetime.datetime.now()
252
246
self.last_checked_ok = None
253
247
self.timeout = string_to_delta(config["timeout"])
346
340
logger.info(u"Starting checker %r for %s",
347
341
command, self.name)
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.)
352
342
self.checker = subprocess.Popen(command,
354
344
shell=True, cwd="/")
355
345
self.checker_callback_tag = gobject.child_watch_add\
356
346
(self.checker.pid,
357
347
self.checker_callback)
358
except OSError, error:
348
except subprocess.OSError, error:
359
349
logger.error(u"Failed to start subprocess: %s",
361
351
# Re-run this periodically if run by gobject.timeout_add
367
357
self.checker_callback_tag = None
368
358
if getattr(self, "checker", None) is None:
370
logger.debug(u"Stopping checker for %(name)s", vars(self))
360
logger.debug("Stopping checker for %(name)s", vars(self))
372
362
os.kill(self.checker.pid, signal.SIGTERM)
406
396
def fingerprint(openpgp):
407
397
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
398
# New empty GnuTLS certificate
399
crt = gnutls.library.types.gnutls_openpgp_crt_t()
400
gnutls.library.functions.gnutls_openpgp_crt_init\
408
402
# New GnuTLS "datum" with the OpenPGP public key
409
403
datum = gnutls.library.types.gnutls_datum_t\
410
404
(ctypes.cast(ctypes.c_char_p(openpgp),
411
405
ctypes.POINTER(ctypes.c_ubyte)),
412
406
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\
417
407
# Import the OpenPGP public key into the certificate
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")
408
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
411
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
428
412
# New buffer for the fingerprint
429
buf = ctypes.create_string_buffer(20)
430
buf_len = ctypes.c_size_t()
413
buffer = ctypes.create_string_buffer(20)
414
buffer_length = ctypes.c_size_t()
431
415
# Get the fingerprint from the certificate into the buffer
432
416
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
433
(crt, ctypes.byref(buf), ctypes.byref(buf_len))
417
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
434
418
# Deinit the certificate
435
419
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
436
420
# Convert the buffer to a Python bytestring
437
fpr = ctypes.string_at(buf, buf_len.value)
421
fpr = ctypes.string_at(buffer, buffer_length.value)
438
422
# Convert the bytestring to hexadecimal notation
439
423
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
443
class TCP_handler(SocketServer.BaseRequestHandler, object):
427
class tcp_handler(SocketServer.BaseRequestHandler, object):
444
428
"""A TCP request handler class.
445
429
Instantiated by IPv6_TCPServer for each request to handle it.
446
430
Note: This will run in its own forked process."""
532
515
if "clients" in kwargs:
533
516
self.clients = kwargs["clients"]
534
517
del kwargs["clients"]
536
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
518
return super(type(self), self).__init__(*args, **kwargs)
537
519
def server_bind(self):
538
520
"""This overrides the normal server_bind() function
539
521
to bind to an interface if one was specified, and also NOT to
558
540
in6addr_any = "::"
559
541
self.server_address = (in6addr_any,
560
542
self.server_address[1])
561
elif not self.server_address[1]:
543
elif self.server_address[1] is None:
562
544
self.server_address = (self.server_address[0],
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()
546
return super(type(self), self).server_bind()
579
549
def string_to_delta(interval):
589
559
datetime.timedelta(1)
590
560
>>> string_to_delta(u'1w')
591
561
datetime.timedelta(7)
592
>>> string_to_delta('5m 30s')
593
datetime.timedelta(0, 330)
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):
564
suffix=unicode(interval[-1])
565
value=int(interval[:-1])
567
delta = datetime.timedelta(value)
569
delta = datetime.timedelta(0, value)
571
delta = datetime.timedelta(0, 0, 0, 0, value)
573
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
575
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
578
except (ValueError, IndexError):
618
583
def server_state_changed(state):
619
584
"""Derived from the Avahi example code"""
620
585
if state == avahi.SERVER_COLLISION:
621
logger.error(u"Zeroconf server name collision")
586
logger.error(u"Server name collision")
623
588
elif state == avahi.SERVER_RUNNING:
627
592
def entry_group_state_changed(state, error):
628
593
"""Derived from the Avahi example code"""
629
logger.debug(u"Avahi state change: %i", state)
594
logger.debug(u"state change: %i", state)
631
596
if state == avahi.ENTRY_GROUP_ESTABLISHED:
632
logger.debug(u"Zeroconf service established.")
597
logger.debug(u"Service established.")
633
598
elif state == avahi.ENTRY_GROUP_COLLISION:
634
logger.warning(u"Zeroconf service name collision.")
599
logger.warning(u"Service name collision.")
636
601
elif state == avahi.ENTRY_GROUP_FAILURE:
637
logger.critical(u"Avahi: Error in group state changed %s",
602
logger.critical(u"Error in group state changed %s",
639
604
raise AvahiGroupError("State changed: %s", str(error))
688
parser = OptionParser(version = "%%prog %s" % version)
653
global main_loop_started
654
main_loop_started = False
656
parser = OptionParser()
689
657
parser.add_option("-i", "--interface", type="string",
690
658
metavar="IF", help="Bind to interface IF")
691
659
parser.add_option("-a", "--address", type="string",
694
662
help="Port number to receive requests on")
695
663
parser.add_option("--check", action="store_true", default=False,
696
664
help="Run self-test")
697
parser.add_option("--debug", action="store_true",
665
parser.add_option("--debug", action="store_true", default=False,
698
666
help="Debug mode; run in foreground and log to"
700
668
parser.add_option("--priority", type="string", help="GnuTLS"
725
693
# Parse config file for server-global settings
726
694
server_config = ConfigParser.SafeConfigParser(server_defaults)
727
695
del server_defaults
728
server_config.read(os.path.join(options.configdir, "mandos.conf"))
696
server_config.read(os.path.join(options.configdir, "server.conf"))
697
server_section = "server"
729
698
# Convert the SafeConfigParser object to a dict
730
server_settings = server_config.defaults()
699
server_settings = dict(server_config.items(server_section))
731
700
# Use getboolean on the boolean config option
732
701
server_settings["debug"] = server_config.getboolean\
702
(server_section, "debug")
734
703
del server_config
736
705
# Override the settings from the config file with command line
744
713
# 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"]))
758
715
# Parse config file with clients
759
716
client_defaults = { "timeout": "1h",
760
717
"interval": "5m",
761
"checker": "fping -q -- %(host)s",
718
"checker": "fping -q -- %%(fqdn)s",
764
720
client_config = ConfigParser.SafeConfigParser(client_defaults)
765
721
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:
804
725
service = AvahiService(name = server_settings["servicename"],
805
servicetype = "_mandos._tcp", )
726
type = "_mandos._tcp", );
806
727
if server_settings["interface"]:
807
service.interface = if_nametoindex\
808
(server_settings["interface"])
728
service.interface = if_nametoindex(server_settings["interface"])
814
734
DBusGMainLoop(set_as_default=True )
815
735
main_loop = gobject.MainLoop()
816
736
bus = dbus.SystemBus()
817
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
818
avahi.DBUS_PATH_SERVER),
819
avahi.DBUS_INTERFACE_SERVER)
737
server = dbus.Interface(
738
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
739
avahi.DBUS_INTERFACE_SERVER )
820
740
# End of Avahi example code
742
debug = server_settings["debug"]
745
console = logging.StreamHandler()
746
# console.setLevel(logging.DEBUG)
747
console.setFormatter(logging.Formatter\
748
('%(levelname)s: %(message)s'))
749
logger.addHandler(console)
822
753
def remove_from_clients(client):
823
754
clients.remove(client)
831
762
= dict(client_config.items(section)))
832
763
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
863
769
"Cleanup function; run on exit"
883
789
for client in clients:
887
tcp_server.server_activate()
792
tcp_server = IPv6_TCPServer((server_settings["address"],
793
server_settings["port"]),
795
settings=server_settings,
889
797
# Find out what port we got
890
798
service.port = tcp_server.socket.getsockname()[1]
891
799
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"