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
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.
66
76
logger = logging.Logger('mandos')
67
77
syslogger = logging.handlers.SysLogHandler\
68
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
78
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
70
79
syslogger.setFormatter(logging.Formatter\
71
('Mandos: %(levelname)s: %(message)s'))
80
('%(levelname)s: %(message)s'))
72
81
logger.addHandler(syslogger)
75
85
class AvahiError(Exception):
88
98
class AvahiService(object):
89
"""An Avahi (Zeroconf) service.
91
100
interface: integer; avahi.IF_UNSPEC or an interface index.
92
101
Used to optionally bind to the specified interface.
93
name: string; Example: 'Mandos'
94
type: string; Example: '_mandos._tcp'.
95
See <http://www.dns-sd.org/ServiceTypes.html>
96
port: integer; what port to announce
97
TXT: list of strings; TXT record for the service
98
domain: string; Domain to publish on, default to .local if empty.
99
host: string; Host to publish records for, default is localhost
100
max_renames: integer; maximum number of renames
101
rename_count: integer; counter so we only rename after collisions
102
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
104
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
105
115
type = None, port = None, TXT = None, domain = "",
106
host = "", max_renames = 32768):
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
107
118
self.interface = interface
122
133
u" retries, exiting.", rename_count)
123
134
raise AvahiServiceError("Too many renames")
124
135
name = server.GetAlternativeServiceName(name)
125
logger.error(u"Changing name to %r ...", name)
126
syslogger.setFormatter(logging.Formatter\
127
('Mandos (%s): %%(levelname)s:'
128
' %%(message)s' % name))
136
logger.notice(u"Changing name to %r ...", name)
131
139
self.rename_count += 1
167
175
fingerprint: string (40 or 32 hexadecimal digits); used to
168
176
uniquely identify the client
169
177
secret: bytestring; sent verbatim (over TLS) to client
170
host: string; available for use by the checker command
178
fqdn: string (FQDN); available for use by the checker command
171
179
created: datetime.datetime(); object creation, not client host
172
180
last_checked_ok: datetime.datetime() or None if not yet checked OK
173
181
timeout: datetime.timedelta(); How long from last_checked_ok
213
221
interval = property(lambda self: self._interval,
215
223
del _set_interval
216
def __init__(self, name = None, stop_hook=None, config={}):
217
"""Note: the 'checker' key in 'config' sets the
218
'checker_command' attribute and *not* the 'checker'
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
230
logger.debug(u"Creating client %r", self.name)
222
# Uppercase and remove spaces from fingerprint for later
223
# comparison purposes with return value from the fingerprint()
225
self.fingerprint = config["fingerprint"].upper()\
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
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
228
if "secret" in config:
229
self.secret = config["secret"].decode(u"base64")
230
elif "secfile" in config:
231
sf = open(config["secfile"])
237
self.secret = secret.decode(u"base64")
232
240
self.secret = sf.read()
235
243
raise TypeError(u"No secret or secfile for client %s"
237
self.host = config.get("host", "")
238
246
self.created = datetime.datetime.now()
239
247
self.last_checked_ok = None
240
self.timeout = string_to_delta(config["timeout"])
241
self.interval = string_to_delta(config["interval"])
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
242
250
self.stop_hook = stop_hook
243
251
self.checker = None
244
252
self.checker_initiator_tag = None
245
253
self.stop_initiator_tag = None
246
254
self.checker_callback_tag = None
247
self.check_command = config["checker"]
255
self.check_command = checker
249
257
"""Start this client's checker and timeout hooks"""
250
258
# Schedule a new checker to be started an 'interval' from now,
263
271
The possibility that a client might be restarted is left open,
264
272
but not currently used."""
265
273
# If this client doesn't have a secret, it is already stopped.
266
if hasattr(self, "secret") and self.secret:
267
logger.info(u"Stopping client %s", self.name)
275
logger.debug(u"Stopping client %s", self.name)
268
276
self.secret = None
289
297
self.checker = None
290
298
if os.WIFEXITED(condition) \
291
299
and (os.WEXITSTATUS(condition) == 0):
292
logger.info(u"Checker for %(name)s succeeded",
300
logger.debug(u"Checker for %(name)s succeeded",
294
302
self.last_checked_ok = now
295
303
gobject.source_remove(self.stop_initiator_tag)
296
304
self.stop_initiator_tag = gobject.timeout_add\
300
308
logger.warning(u"Checker for %(name)s crashed?",
303
logger.info(u"Checker for %(name)s failed",
311
logger.debug(u"Checker for %(name)s failed",
305
313
def start_checker(self):
306
314
"""Start a new checker subprocess if one is not running.
307
315
If a checker already exists, leave it running and do
330
338
u' %s', self.check_command, error)
331
339
return True # Try again later
333
logger.info(u"Starting checker %r for %s",
341
logger.debug(u"Starting checker %r for %s",
335
343
self.checker = subprocess.Popen(command,
337
345
shell=True, cwd="/")
350
358
self.checker_callback_tag = None
351
359
if getattr(self, "checker", None) is None:
353
logger.debug(u"Stopping checker for %(name)s", vars(self))
361
logger.debug("Stopping checker for %(name)s", vars(self))
355
363
os.kill(self.checker.pid, signal.SIGTERM)
389
397
def fingerprint(openpgp):
390
398
"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\
391
403
# New GnuTLS "datum" with the OpenPGP public key
392
404
datum = gnutls.library.types.gnutls_datum_t\
393
405
(ctypes.cast(ctypes.c_char_p(openpgp),
394
406
ctypes.POINTER(ctypes.c_ubyte)),
395
407
ctypes.c_uint(len(openpgp)))
396
# New empty GnuTLS certificate
397
crt = gnutls.library.types.gnutls_openpgp_crt_t()
398
gnutls.library.functions.gnutls_openpgp_crt_init\
400
408
# Import the OpenPGP public key into the certificate
401
gnutls.library.functions.gnutls_openpgp_crt_import\
402
(crt, ctypes.byref(datum),
403
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
409
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
412
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
404
413
# New buffer for the fingerprint
405
414
buffer = ctypes.create_string_buffer(20)
406
415
buffer_length = ctypes.c_size_t()
422
431
Note: This will run in its own forked process."""
424
433
def handle(self):
425
logger.info(u"TCP connection from: %s",
434
logger.debug(u"TCP connection from: %s",
426
435
unicode(self.client_address))
427
436
session = gnutls.connection.ClientSession\
428
437
(self.request, gnutls.connection.X509Credentials())
430
line = self.request.makefile().readline()
431
logger.debug(u"Protocol version: %r", line)
433
if int(line.strip().split()[0]) > 1:
435
except (ValueError, IndexError, RuntimeError), error:
436
logger.error(u"Unknown protocol version: %s", error)
439
438
# Note: gnutls.connection.X509Credentials is really a generic
440
439
# GnuTLS certificate credentials object so long as no X.509
441
440
# keys are added to it. Therefore, we can use it here despite
455
454
session.handshake()
456
455
except gnutls.errors.GNUTLSError, error:
457
logger.warning(u"Handshake failed: %s", error)
456
logger.debug(u"Handshake failed: %s", error)
458
457
# Do not run session.bye() here: the session is not
459
458
# established. Just abandon the request.
462
461
fpr = fingerprint(peer_certificate(session))
463
462
except (TypeError, gnutls.errors.GNUTLSError), error:
464
logger.warning(u"Bad certificate: %s", error)
463
logger.debug(u"Bad certificate: %s", error)
467
466
logger.debug(u"Fingerprint: %s", fpr)
474
logger.warning(u"Client not found for fingerprint: %s",
473
logger.debug(u"Client not found for fingerprint: %s", fpr)
478
476
# Have to check if client.still_valid(), since it is possible
479
477
# that the client timed out while establishing the GnuTLS
481
479
if not client.still_valid():
482
logger.warning(u"Client %(name)s is invalid",
480
logger.debug(u"Client %(name)s is invalid", vars(client))
512
509
"""This overrides the normal server_bind() function
513
510
to bind to an interface if one was specified, and also NOT to
514
511
bind to an address or port if they were not specified."""
515
if self.settings["interface"]:
512
if self.settings["interface"] != avahi.IF_UNSPEC:
516
513
# 25 is from /usr/include/asm-i486/socket.h
517
514
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
521
518
self.settings["interface"])
522
519
except socket.error, error:
523
520
if error[0] == errno.EPERM:
524
logger.error(u"No permission to"
525
u" bind to interface %s",
526
self.settings["interface"])
521
logger.warning(u"No permission to"
522
u" bind to interface %s",
523
self.settings["interface"])
529
526
# Only bind(2) the socket if we really need to.
532
529
in6addr_any = "::"
533
530
self.server_address = (in6addr_any,
534
531
self.server_address[1])
535
elif not self.server_address[1]:
532
elif self.server_address[1] is None:
536
533
self.server_address = (self.server_address[0],
538
# if self.settings["interface"]:
539
# self.server_address = (self.server_address[0],
545
535
return super(type(self), self).server_bind()
582
572
def server_state_changed(state):
583
573
"""Derived from the Avahi example code"""
584
574
if state == avahi.SERVER_COLLISION:
585
logger.error(u"Server name collision")
575
logger.warning(u"Server name collision")
587
577
elif state == avahi.SERVER_RUNNING:
603
593
raise AvahiGroupError("State changed: %s", str(error))
605
def if_nametoindex(interface):
595
def if_nametoindex(interface, _func=[None]):
606
596
"""Call the C function if_nametoindex(), or equivalent"""
607
global if_nametoindex
597
if _func[0] is not None:
598
return _func[0](interface)
609
600
if "ctypes.util" not in sys.modules:
610
601
import ctypes.util
611
if_nametoindex = ctypes.cdll.LoadLibrary\
612
(ctypes.util.find_library("c")).if_nametoindex
604
libc = ctypes.cdll.LoadLibrary\
605
(ctypes.util.find_library("c"))
606
func[0] = libc.if_nametoindex
607
return _func[0](interface)
613
611
except (OSError, AttributeError):
614
612
if "struct" not in sys.modules:
616
614
if "fcntl" not in sys.modules:
618
def if_nametoindex(interface):
616
def the_hard_way(interface):
619
617
"Get an interface index the hard way, i.e. using fcntl()"
620
618
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
621
619
s = socket.socket()
625
623
interface_index = struct.unpack("I", ifreq[16:20])[0]
626
624
return interface_index
627
return if_nametoindex(interface)
630
def daemon(nochdir = False, noclose = False):
625
_func[0] = the_hard_way
626
return _func[0](interface)
629
def daemon(nochdir, noclose):
631
630
"""See daemon(3). Standard BSD Unix function.
632
631
This should really exist as os.daemon, but it doesn't (yet)."""
654
651
global main_loop_started
655
652
main_loop_started = False
657
parser = OptionParser(version = "Mandos server %s" % version)
654
parser = OptionParser()
658
655
parser.add_option("-i", "--interface", type="string",
659
656
metavar="IF", help="Bind to interface IF")
660
657
parser.add_option("-a", "--address", type="string",
663
660
help="Port number to receive requests on")
664
661
parser.add_option("--check", action="store_true", default=False,
665
662
help="Run self-test")
666
parser.add_option("--debug", action="store_true",
663
parser.add_option("--debug", action="store_true", default=False,
667
664
help="Debug mode; run in foreground and log to"
669
666
parser.add_option("--priority", type="string", help="GnuTLS"
694
691
# Parse config file for server-global settings
695
692
server_config = ConfigParser.SafeConfigParser(server_defaults)
696
693
del server_defaults
697
server_config.read(os.path.join(options.configdir, "mandos.conf"))
694
server_config.read(os.path.join(options.configdir, "server.conf"))
698
695
server_section = "server"
699
696
# Convert the SafeConfigParser object to a dict
700
697
server_settings = dict(server_config.items(server_section))
714
713
# Now we have our good server settings in "server_settings"
716
debug = server_settings["debug"]
719
syslogger.setLevel(logging.WARNING)
721
if server_settings["servicename"] != "Mandos":
722
syslogger.setFormatter(logging.Formatter\
723
('Mandos (%s): %%(levelname)s:'
725
% server_settings["servicename"]))
727
715
# Parse config file with clients
728
716
client_defaults = { "timeout": "1h",
729
717
"interval": "5m",
730
"checker": "fping -q -- %%(host)s",
718
"checker": "fping -q -- %%(fqdn)s",
732
720
client_config = ConfigParser.SafeConfigParser(client_defaults)
733
721
client_config.read(os.path.join(server_settings["configdir"],
763
751
def remove_from_clients(client):
764
752
clients.remove(client)
766
logger.critical(u"No clients left, exiting")
754
logger.debug(u"No clients left, exiting")
769
clients.update(Set(Client(name = section,
757
clients.update(Set(Client(name=section,
770
758
stop_hook = remove_from_clients,
772
= dict(client_config.items(section)))
759
**(dict(client_config\
773
761
for section in client_config.sections()))
775
logger.critical(u"No clients defined")
781
pidfilename = "/var/run/mandos/mandos.pid"
784
pidfile = open(pidfilename, "w")
785
pidfile.write(str(pid) + "\n")
789
logger.error(u"Could not write %s file with PID %d",
790
pidfilename, os.getpid())
793
767
"Cleanup function; run on exit"
821
795
# Find out what port we got
822
796
service.port = tcp_server.socket.getsockname()[1]
823
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
824
u" scope_id %d" % tcp_server.socket.getsockname())
797
logger.debug(u"Now listening on port %d", service.port)
826
#service.interface = tcp_server.socket.getsockname()[3]
799
if not server_settings["interface"]:
800
service.interface = if_nametoindex\
801
(server_settings["interface"])
829
804
# From the Avahi example code