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
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(config["secfile"])
244
self.secret = secfile.read()
243
247
raise TypeError(u"No secret or secfile for client %s"
249
self.host = config.get("host", "")
246
250
self.created = datetime.datetime.now()
247
251
self.last_checked_ok = None
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
252
self.timeout = string_to_delta(config["timeout"])
253
self.interval = string_to_delta(config["interval"])
250
254
self.stop_hook = stop_hook
251
255
self.checker = None
252
256
self.checker_initiator_tag = None
253
257
self.stop_initiator_tag = None
254
258
self.checker_callback_tag = None
255
self.check_command = checker
259
self.check_command = config["checker"]
257
261
"""Start this client's checker and timeout hooks"""
258
262
# Schedule a new checker to be started an 'interval' from now,
338
342
u' %s', self.check_command, error)
339
343
return True # Try again later
341
logger.debug(u"Starting checker %r for %s",
345
logger.info(u"Starting checker %r for %s",
347
# We don't need to redirect stdout and stderr, since
348
# in normal mode, that is already done by daemon(),
349
# and in debug mode we don't want to. (Stdin is
350
# always replaced by /dev/null.)
343
351
self.checker = subprocess.Popen(command,
345
353
shell=True, cwd="/")
346
354
self.checker_callback_tag = gobject.child_watch_add\
347
355
(self.checker.pid,
348
356
self.checker_callback)
349
except subprocess.OSError, error:
357
except OSError, error:
350
358
logger.error(u"Failed to start subprocess: %s",
352
360
# Re-run this periodically if run by gobject.timeout_add
397
405
def fingerprint(openpgp):
398
406
"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
407
# New GnuTLS "datum" with the OpenPGP public key
404
408
datum = gnutls.library.types.gnutls_datum_t\
405
409
(ctypes.cast(ctypes.c_char_p(openpgp),
406
410
ctypes.POINTER(ctypes.c_ubyte)),
407
411
ctypes.c_uint(len(openpgp)))
412
# New empty GnuTLS certificate
413
crt = gnutls.library.types.gnutls_openpgp_crt_t()
414
gnutls.library.functions.gnutls_openpgp_crt_init\
408
416
# 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)
417
gnutls.library.functions.gnutls_openpgp_crt_import\
418
(crt, ctypes.byref(datum),
419
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
420
# Verify the self signature in the key
421
crtverify = ctypes.c_uint()
422
gnutls.library.functions.gnutls_openpgp_crt_verify_self\
423
(crt, 0, ctypes.byref(crtverify))
424
if crtverify.value != 0:
425
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
426
raise gnutls.errors.CertificateSecurityError("Verify failed")
413
427
# New buffer for the fingerprint
414
buffer = ctypes.create_string_buffer(20)
415
buffer_length = ctypes.c_size_t()
428
buf = ctypes.create_string_buffer(20)
429
buf_len = ctypes.c_size_t()
416
430
# Get the fingerprint from the certificate into the buffer
417
431
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
418
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
432
(crt, ctypes.byref(buf), ctypes.byref(buf_len))
419
433
# Deinit the certificate
420
434
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
421
435
# Convert the buffer to a Python bytestring
422
fpr = ctypes.string_at(buffer, buffer_length.value)
436
fpr = ctypes.string_at(buf, buf_len.value)
423
437
# Convert the bytestring to hexadecimal notation
424
438
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
442
class TCP_handler(SocketServer.BaseRequestHandler, object):
429
443
"""A TCP request handler class.
430
444
Instantiated by IPv6_TCPServer for each request to handle it.
431
445
Note: This will run in its own forked process."""
433
447
def handle(self):
434
logger.debug(u"TCP connection from: %s",
448
logger.info(u"TCP connection from: %s",
435
449
unicode(self.client_address))
436
450
session = gnutls.connection.ClientSession\
437
451
(self.request, gnutls.connection.X509Credentials())
453
line = self.request.makefile().readline()
454
logger.debug(u"Protocol version: %r", line)
456
if int(line.strip().split()[0]) > 1:
458
except (ValueError, IndexError, RuntimeError), error:
459
logger.error(u"Unknown protocol version: %s", error)
438
462
# Note: gnutls.connection.X509Credentials is really a generic
439
463
# GnuTLS certificate credentials object so long as no X.509
440
464
# keys are added to it. Therefore, we can use it here despite
448
472
if self.server.settings["priority"]:
449
473
priority = self.server.settings["priority"]
450
474
gnutls.library.functions.gnutls_priority_set_direct\
451
(session._c_object, priority, None);
475
(session._c_object, priority, None)
454
478
session.handshake()
455
479
except gnutls.errors.GNUTLSError, error:
456
logger.debug(u"Handshake failed: %s", error)
480
logger.warning(u"Handshake failed: %s", error)
457
481
# Do not run session.bye() here: the session is not
458
482
# established. Just abandon the request.
461
485
fpr = fingerprint(peer_certificate(session))
462
486
except (TypeError, gnutls.errors.GNUTLSError), error:
463
logger.debug(u"Bad certificate: %s", error)
487
logger.warning(u"Bad certificate: %s", error)
466
490
logger.debug(u"Fingerprint: %s", fpr)
504
531
if "clients" in kwargs:
505
532
self.clients = kwargs["clients"]
506
533
del kwargs["clients"]
507
return super(type(self), self).__init__(*args, **kwargs)
535
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
508
536
def server_bind(self):
509
537
"""This overrides the normal server_bind() function
510
538
to bind to an interface if one was specified, and also NOT to
511
539
bind to an address or port if they were not specified."""
512
if self.settings["interface"] != avahi.IF_UNSPEC:
540
if self.settings["interface"]:
513
541
# 25 is from /usr/include/asm-i486/socket.h
514
542
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
518
546
self.settings["interface"])
519
547
except socket.error, error:
520
548
if error[0] == errno.EPERM:
521
logger.warning(u"No permission to"
522
u" bind to interface %s",
523
self.settings["interface"])
549
logger.error(u"No permission to"
550
u" bind to interface %s",
551
self.settings["interface"])
526
554
# Only bind(2) the socket if we really need to.
529
557
in6addr_any = "::"
530
558
self.server_address = (in6addr_any,
531
559
self.server_address[1])
532
elif self.server_address[1] is None:
560
elif not self.server_address[1]:
533
561
self.server_address = (self.server_address[0],
535
return super(type(self), self).server_bind()
563
# if self.settings["interface"]:
564
# self.server_address = (self.server_address[0],
570
return super(IPv6_TCPServer, self).server_bind()
571
def server_activate(self):
573
return super(IPv6_TCPServer, self).server_activate()
538
578
def string_to_delta(interval):
548
588
datetime.timedelta(1)
549
589
>>> string_to_delta(u'1w')
550
590
datetime.timedelta(7)
591
>>> string_to_delta('5m 30s')
592
datetime.timedelta(0, 330)
553
suffix=unicode(interval[-1])
554
value=int(interval[:-1])
556
delta = datetime.timedelta(value)
558
delta = datetime.timedelta(0, value)
560
delta = datetime.timedelta(0, 0, 0, 0, value)
562
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
564
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
594
timevalue = datetime.timedelta(0)
595
for s in interval.split():
597
suffix = unicode(s[-1])
600
delta = datetime.timedelta(value)
602
delta = datetime.timedelta(0, value)
604
delta = datetime.timedelta(0, 0, 0, 0, value)
606
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
608
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
611
except (ValueError, IndexError):
567
except (ValueError, IndexError):
572
617
def server_state_changed(state):
573
618
"""Derived from the Avahi example code"""
574
619
if state == avahi.SERVER_COLLISION:
575
logger.warning(u"Server name collision")
620
logger.error(u"Zeroconf server name collision")
577
622
elif state == avahi.SERVER_RUNNING:
581
626
def entry_group_state_changed(state, error):
582
627
"""Derived from the Avahi example code"""
583
logger.debug(u"state change: %i", state)
628
logger.debug(u"Avahi state change: %i", state)
585
630
if state == avahi.ENTRY_GROUP_ESTABLISHED:
586
logger.debug(u"Service established.")
631
logger.debug(u"Zeroconf service established.")
587
632
elif state == avahi.ENTRY_GROUP_COLLISION:
588
logger.warning(u"Service name collision.")
633
logger.warning(u"Zeroconf service name collision.")
590
635
elif state == avahi.ENTRY_GROUP_FAILURE:
591
logger.critical(u"Error in group state changed %s",
636
logger.critical(u"Avahi: Error in group state changed %s",
593
638
raise AvahiGroupError("State changed: %s", str(error))
595
def if_nametoindex(interface, _func=[None]):
640
def if_nametoindex(interface):
596
641
"""Call the C function if_nametoindex(), or equivalent"""
597
if _func[0] is not None:
598
return _func[0](interface)
642
global if_nametoindex
600
if "ctypes.util" not in sys.modules:
604
libc = ctypes.cdll.LoadLibrary\
605
(ctypes.util.find_library("c"))
606
func[0] = libc.if_nametoindex
607
return _func[0](interface)
644
if_nametoindex = ctypes.cdll.LoadLibrary\
645
(ctypes.util.find_library("c")).if_nametoindex
611
646
except (OSError, AttributeError):
612
647
if "struct" not in sys.modules:
614
649
if "fcntl" not in sys.modules:
616
def the_hard_way(interface):
651
def if_nametoindex(interface):
617
652
"Get an interface index the hard way, i.e. using fcntl()"
618
653
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
619
654
s = socket.socket()
660
693
help="Port number to receive requests on")
661
694
parser.add_option("--check", action="store_true", default=False,
662
695
help="Run self-test")
663
parser.add_option("--debug", action="store_true", default=False,
696
parser.add_option("--debug", action="store_true",
664
697
help="Debug mode; run in foreground and log to"
666
699
parser.add_option("--priority", type="string", help="GnuTLS"
691
724
# Parse config file for server-global settings
692
725
server_config = ConfigParser.SafeConfigParser(server_defaults)
693
726
del server_defaults
694
server_config.read(os.path.join(options.configdir, "server.conf"))
695
server_section = "server"
727
server_config.read(os.path.join(options.configdir, "mandos.conf"))
696
728
# Convert the SafeConfigParser object to a dict
697
server_settings = dict(server_config.items(server_section))
729
server_settings = server_config.defaults()
698
730
# Use getboolean on the boolean config option
699
731
server_settings["debug"] = server_config.getboolean\
700
(server_section, "debug")
701
733
del server_config
702
if not server_settings["interface"]:
703
server_settings["interface"] = avahi.IF_UNSPEC
705
735
# Override the settings from the config file with command line
706
736
# options, if set.
713
743
# Now we have our good server settings in "server_settings"
745
debug = server_settings["debug"]
748
syslogger.setLevel(logging.WARNING)
749
console.setLevel(logging.WARNING)
751
if server_settings["servicename"] != "Mandos":
752
syslogger.setFormatter(logging.Formatter\
753
('Mandos (%s): %%(levelname)s:'
755
% server_settings["servicename"]))
715
757
# Parse config file with clients
716
758
client_defaults = { "timeout": "1h",
717
759
"interval": "5m",
718
"checker": "fping -q -- %%(fqdn)s",
760
"checker": "fping -q -- %(host)s",
720
763
client_config = ConfigParser.SafeConfigParser(client_defaults)
721
764
client_config.read(os.path.join(server_settings["configdir"],
768
tcp_server = IPv6_TCPServer((server_settings["address"],
769
server_settings["port"]),
771
settings=server_settings,
773
pidfilename = "/var/run/mandos.pid"
775
pidfile = open(pidfilename, "w")
776
except IOError, error:
777
logger.error("Could not open file %r", pidfilename)
782
uid = pwd.getpwnam("mandos").pw_uid
785
uid = pwd.getpwnam("nobody").pw_uid
789
gid = pwd.getpwnam("mandos").pw_gid
792
gid = pwd.getpwnam("nogroup").pw_gid
798
except OSError, error:
799
if error[0] != errno.EPERM:
725
803
service = AvahiService(name = server_settings["servicename"],
726
type = "_mandos._tcp", );
804
servicetype = "_mandos._tcp", )
805
if server_settings["interface"]:
806
service.interface = if_nametoindex\
807
(server_settings["interface"])
732
813
DBusGMainLoop(set_as_default=True )
733
814
main_loop = gobject.MainLoop()
734
815
bus = dbus.SystemBus()
735
server = dbus.Interface(
736
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
737
avahi.DBUS_INTERFACE_SERVER )
816
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
817
avahi.DBUS_PATH_SERVER),
818
avahi.DBUS_INTERFACE_SERVER)
738
819
# 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
821
def remove_from_clients(client):
752
822
clients.remove(client)
754
logger.debug(u"No clients left, exiting")
824
logger.critical(u"No clients left, exiting")
757
clients.update(Set(Client(name=section,
827
clients.update(Set(Client(name = section,
758
828
stop_hook = remove_from_clients,
759
**(dict(client_config\
830
= dict(client_config.items(section)))
761
831
for section in client_config.sections()))
833
logger.critical(u"No clients defined")
837
# Redirect stdin so all checkers get /dev/null
838
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
839
os.dup2(null, sys.stdin.fileno())
844
logger.removeHandler(console)
845
# Close all input and output, do double fork, etc.
850
pidfile.write(str(pid) + "\n")
854
logger.error(u"Could not write to file %r with PID %d",
857
# "pidfile" was never created
767
862
"Cleanup function; run on exit"
787
882
for client in clients:
790
tcp_server = IPv6_TCPServer((server_settings["address"],
791
server_settings["port"]),
793
settings=server_settings,
886
tcp_server.server_activate()
795
888
# Find out what port we got
796
889
service.port = tcp_server.socket.getsockname()[1]
797
logger.debug(u"Now listening on port %d", service.port)
890
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
891
u" scope_id %d" % tcp_server.socket.getsockname())
799
if not server_settings["interface"]:
800
service.interface = if_nametoindex\
801
(server_settings["interface"])
893
#service.interface = tcp_server.socket.getsockname()[3]
804
896
# From the Avahi example code