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
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
61
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.
76
66
logger = logging.Logger('mandos')
77
67
syslogger = logging.handlers.SysLogHandler\
78
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
68
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
79
70
syslogger.setFormatter(logging.Formatter\
80
('%(levelname)s: %(message)s'))
71
('Mandos: %(levelname)s: %(message)s'))
81
72
logger.addHandler(syslogger)
74
console = logging.StreamHandler()
75
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
77
logger.addHandler(console)
85
79
class AvahiError(Exception):
86
80
def __init__(self, value):
98
92
class AvahiService(object):
93
"""An Avahi (Zeroconf) service.
100
95
interface: integer; avahi.IF_UNSPEC or an interface index.
101
96
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
97
name: string; Example: 'Mandos'
98
type: string; Example: '_mandos._tcp'.
99
See <http://www.dns-sd.org/ServiceTypes.html>
100
port: integer; what port to announce
101
TXT: list of strings; TXT record for the service
102
domain: string; Domain to publish on, default to .local if empty.
103
host: string; Host to publish records for, default is localhost
104
max_renames: integer; maximum number of renames
105
rename_count: integer; counter so we only rename after collisions
106
a sensible number of times
114
108
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
109
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
110
host = "", max_renames = 32768):
118
111
self.interface = interface
126
119
self.domain = domain
128
121
self.rename_count = 0
122
self.max_renames = max_renames
129
123
def rename(self):
130
124
"""Derived from the Avahi example code"""
131
125
if self.rename_count >= self.max_renames:
132
126
logger.critical(u"No suitable service name found after %i"
133
127
u" retries, exiting.", rename_count)
134
128
raise AvahiServiceError("Too many renames")
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
129
self.name = server.GetAlternativeServiceName(self.name)
130
logger.info(u"Changing name to %r ...", str(self.name))
131
syslogger.setFormatter(logging.Formatter\
132
('Mandos (%s): %%(levelname)s:'
133
' %%(message)s' % self.name))
139
136
self.rename_count += 1
175
172
fingerprint: string (40 or 32 hexadecimal digits); used to
176
173
uniquely identify the client
177
174
secret: bytestring; sent verbatim (over TLS) to client
178
fqdn: string (FQDN); available for use by the checker command
175
host: string; available for use by the checker command
179
176
created: datetime.datetime(); object creation, not client host
180
177
last_checked_ok: datetime.datetime() or None if not yet checked OK
181
178
timeout: datetime.timedelta(); How long from last_checked_ok
221
218
interval = property(lambda self: self._interval,
223
220
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.."""
221
def __init__(self, name = None, stop_hook=None, config={}):
222
"""Note: the 'checker' key in 'config' sets the
223
'checker_command' attribute and *not* the 'checker'
230
226
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"")
227
# Uppercase and remove spaces from fingerprint for later
228
# comparison purposes with return value from the fingerprint()
230
self.fingerprint = config["fingerprint"].upper()\
235
232
logger.debug(u" Fingerprint: %s", self.fingerprint)
237
self.secret = secret.decode(u"base64")
233
if "secret" in config:
234
self.secret = config["secret"].decode(u"base64")
235
elif "secfile" in config:
236
sf = open(config["secfile"])
240
237
self.secret = sf.read()
243
240
raise TypeError(u"No secret or secfile for client %s"
242
self.host = config.get("host", "")
246
243
self.created = datetime.datetime.now()
247
244
self.last_checked_ok = None
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
245
self.timeout = string_to_delta(config["timeout"])
246
self.interval = string_to_delta(config["interval"])
250
247
self.stop_hook = stop_hook
251
248
self.checker = None
252
249
self.checker_initiator_tag = None
253
250
self.stop_initiator_tag = None
254
251
self.checker_callback_tag = None
255
self.check_command = checker
252
self.check_command = config["checker"]
257
254
"""Start this client's checker and timeout hooks"""
258
255
# Schedule a new checker to be started an 'interval' from now,
271
268
The possibility that a client might be restarted is left open,
272
269
but not currently used."""
273
270
# If this client doesn't have a secret, it is already stopped.
275
logger.debug(u"Stopping client %s", self.name)
271
if hasattr(self, "secret") and self.secret:
272
logger.info(u"Stopping client %s", self.name)
276
273
self.secret = None
297
294
self.checker = None
298
295
if os.WIFEXITED(condition) \
299
296
and (os.WEXITSTATUS(condition) == 0):
300
logger.debug(u"Checker for %(name)s succeeded",
297
logger.info(u"Checker for %(name)s succeeded",
302
299
self.last_checked_ok = now
303
300
gobject.source_remove(self.stop_initiator_tag)
304
301
self.stop_initiator_tag = gobject.timeout_add\
308
305
logger.warning(u"Checker for %(name)s crashed?",
311
logger.debug(u"Checker for %(name)s failed",
308
logger.info(u"Checker for %(name)s failed",
313
310
def start_checker(self):
314
311
"""Start a new checker subprocess if one is not running.
315
312
If a checker already exists, leave it running and do
338
335
u' %s', self.check_command, error)
339
336
return True # Try again later
341
logger.debug(u"Starting checker %r for %s",
338
logger.info(u"Starting checker %r for %s",
343
340
self.checker = subprocess.Popen(command,
345
342
shell=True, cwd="/")
358
355
self.checker_callback_tag = None
359
356
if getattr(self, "checker", None) is None:
361
logger.debug("Stopping checker for %(name)s", vars(self))
358
logger.debug(u"Stopping checker for %(name)s", vars(self))
363
360
os.kill(self.checker.pid, signal.SIGTERM)
397
394
def fingerprint(openpgp):
398
395
"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
396
# New GnuTLS "datum" with the OpenPGP public key
404
397
datum = gnutls.library.types.gnutls_datum_t\
405
398
(ctypes.cast(ctypes.c_char_p(openpgp),
406
399
ctypes.POINTER(ctypes.c_ubyte)),
407
400
ctypes.c_uint(len(openpgp)))
401
# New empty GnuTLS certificate
402
crt = gnutls.library.types.gnutls_openpgp_crt_t()
403
gnutls.library.functions.gnutls_openpgp_crt_init\
408
405
# 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)
406
gnutls.library.functions.gnutls_openpgp_crt_import\
407
(crt, ctypes.byref(datum),
408
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
409
# New buffer for the fingerprint
414
410
buffer = ctypes.create_string_buffer(20)
415
411
buffer_length = ctypes.c_size_t()
431
427
Note: This will run in its own forked process."""
433
429
def handle(self):
434
logger.debug(u"TCP connection from: %s",
430
logger.info(u"TCP connection from: %s",
435
431
unicode(self.client_address))
436
432
session = gnutls.connection.ClientSession\
437
433
(self.request, gnutls.connection.X509Credentials())
435
line = self.request.makefile().readline()
436
logger.debug(u"Protocol version: %r", line)
438
if int(line.strip().split()[0]) > 1:
440
except (ValueError, IndexError, RuntimeError), error:
441
logger.error(u"Unknown protocol version: %s", error)
438
444
# Note: gnutls.connection.X509Credentials is really a generic
439
445
# GnuTLS certificate credentials object so long as no X.509
440
446
# keys are added to it. Therefore, we can use it here despite
454
460
session.handshake()
455
461
except gnutls.errors.GNUTLSError, error:
456
logger.debug(u"Handshake failed: %s", error)
462
logger.warning(u"Handshake failed: %s", error)
457
463
# Do not run session.bye() here: the session is not
458
464
# established. Just abandon the request.
461
467
fpr = fingerprint(peer_certificate(session))
462
468
except (TypeError, gnutls.errors.GNUTLSError), error:
463
logger.debug(u"Bad certificate: %s", error)
469
logger.warning(u"Bad certificate: %s", error)
466
472
logger.debug(u"Fingerprint: %s", fpr)
473
logger.debug(u"Client not found for fingerprint: %s", fpr)
479
logger.warning(u"Client not found for fingerprint: %s",
476
483
# Have to check if client.still_valid(), since it is possible
477
484
# that the client timed out while establishing the GnuTLS
479
486
if not client.still_valid():
480
logger.debug(u"Client %(name)s is invalid", vars(client))
487
logger.warning(u"Client %(name)s is invalid",
509
517
"""This overrides the normal server_bind() function
510
518
to bind to an interface if one was specified, and also NOT to
511
519
bind to an address or port if they were not specified."""
512
if self.settings["interface"] != avahi.IF_UNSPEC:
520
if self.settings["interface"]:
513
521
# 25 is from /usr/include/asm-i486/socket.h
514
522
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
518
526
self.settings["interface"])
519
527
except socket.error, error:
520
528
if error[0] == errno.EPERM:
521
logger.warning(u"No permission to"
522
u" bind to interface %s",
523
self.settings["interface"])
529
logger.error(u"No permission to"
530
u" bind to interface %s",
531
self.settings["interface"])
526
534
# Only bind(2) the socket if we really need to.
529
537
in6addr_any = "::"
530
538
self.server_address = (in6addr_any,
531
539
self.server_address[1])
532
elif self.server_address[1] is None:
540
elif not self.server_address[1]:
533
541
self.server_address = (self.server_address[0],
543
# if self.settings["interface"]:
544
# self.server_address = (self.server_address[0],
535
550
return super(type(self), self).server_bind()
572
587
def server_state_changed(state):
573
588
"""Derived from the Avahi example code"""
574
589
if state == avahi.SERVER_COLLISION:
575
logger.warning(u"Server name collision")
590
logger.error(u"Server name collision")
577
592
elif state == avahi.SERVER_RUNNING:
593
608
raise AvahiGroupError("State changed: %s", str(error))
595
def if_nametoindex(interface, _func=[None]):
610
def if_nametoindex(interface):
596
611
"""Call the C function if_nametoindex(), or equivalent"""
597
if _func[0] is not None:
598
return _func[0](interface)
612
global if_nametoindex
600
614
if "ctypes.util" not in sys.modules:
601
615
import ctypes.util
604
libc = ctypes.cdll.LoadLibrary\
605
(ctypes.util.find_library("c"))
606
func[0] = libc.if_nametoindex
607
return _func[0](interface)
616
if_nametoindex = ctypes.cdll.LoadLibrary\
617
(ctypes.util.find_library("c")).if_nametoindex
611
618
except (OSError, AttributeError):
612
619
if "struct" not in sys.modules:
614
621
if "fcntl" not in sys.modules:
616
def the_hard_way(interface):
623
def if_nametoindex(interface):
617
624
"Get an interface index the hard way, i.e. using fcntl()"
618
625
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
619
626
s = socket.socket()
623
630
interface_index = struct.unpack("I", ifreq[16:20])[0]
624
631
return interface_index
625
_func[0] = the_hard_way
626
return _func[0](interface)
629
def daemon(nochdir, noclose):
632
return if_nametoindex(interface)
635
def daemon(nochdir = False, noclose = False):
630
636
"""See daemon(3). Standard BSD Unix function.
631
637
This should really exist as os.daemon, but it doesn't (yet)."""
651
659
global main_loop_started
652
660
main_loop_started = False
654
parser = OptionParser()
662
parser = OptionParser(version = "%%prog %s" % version)
655
663
parser.add_option("-i", "--interface", type="string",
656
664
metavar="IF", help="Bind to interface IF")
657
665
parser.add_option("-a", "--address", type="string",
660
668
help="Port number to receive requests on")
661
669
parser.add_option("--check", action="store_true", default=False,
662
670
help="Run self-test")
663
parser.add_option("--debug", action="store_true", default=False,
671
parser.add_option("--debug", action="store_true",
664
672
help="Debug mode; run in foreground and log to"
666
674
parser.add_option("--priority", type="string", help="GnuTLS"
691
699
# Parse config file for server-global settings
692
700
server_config = ConfigParser.SafeConfigParser(server_defaults)
693
701
del server_defaults
694
server_config.read(os.path.join(options.configdir, "server.conf"))
702
server_config.read(os.path.join(options.configdir, "mandos.conf"))
695
703
server_section = "server"
696
704
# Convert the SafeConfigParser object to a dict
697
705
server_settings = dict(server_config.items(server_section))
713
719
# Now we have our good server settings in "server_settings"
721
debug = server_settings["debug"]
724
syslogger.setLevel(logging.WARNING)
725
console.setLevel(logging.WARNING)
727
if server_settings["servicename"] != "Mandos":
728
syslogger.setFormatter(logging.Formatter\
729
('Mandos (%s): %%(levelname)s:'
731
% server_settings["servicename"]))
715
733
# Parse config file with clients
716
734
client_defaults = { "timeout": "1h",
717
735
"interval": "5m",
718
"checker": "fping -q -- %%(fqdn)s",
736
"checker": "fping -q -- %%(host)s",
720
738
client_config = ConfigParser.SafeConfigParser(client_defaults)
721
739
client_config.read(os.path.join(server_settings["configdir"],
737
757
avahi.DBUS_INTERFACE_SERVER )
738
758
# 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
761
def remove_from_clients(client):
752
762
clients.remove(client)
754
logger.debug(u"No clients left, exiting")
764
logger.critical(u"No clients left, exiting")
757
clients.update(Set(Client(name=section,
767
clients.update(Set(Client(name = section,
758
768
stop_hook = remove_from_clients,
759
**(dict(client_config\
770
= dict(client_config.items(section)))
761
771
for section in client_config.sections()))
773
logger.critical(u"No clients defined")
777
logger.removeHandler(console)
780
pidfilename = "/var/run/mandos/mandos.pid"
783
pidfile = open(pidfilename, "w")
784
pidfile.write(str(pid) + "\n")
788
logger.error(u"Could not write %s file with PID %d",
789
pidfilename, os.getpid())
767
792
"Cleanup function; run on exit"
795
820
# Find out what port we got
796
821
service.port = tcp_server.socket.getsockname()[1]
797
logger.debug(u"Now listening on port %d", service.port)
822
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
823
u" scope_id %d" % tcp_server.socket.getsockname())
799
if not server_settings["interface"]:
800
service.interface = if_nametoindex\
801
(server_settings["interface"])
825
#service.interface = tcp_server.socket.getsockname()[3]
804
828
# From the Avahi example code