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>.
33
from __future__ import division, with_statement, absolute_import
32
from __future__ import division
35
34
import SocketServer
37
37
from optparse import OptionParser
56
56
import logging.handlers
58
from contextlib import closing
63
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.
69
76
logger = logging.Logger('mandos')
70
77
syslogger = logging.handlers.SysLogHandler\
71
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
78
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
73
79
syslogger.setFormatter(logging.Formatter\
74
('Mandos: %(levelname)s: %(message)s'))
80
('%(levelname)s: %(message)s'))
75
81
logger.addHandler(syslogger)
77
console = logging.StreamHandler()
78
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
80
logger.addHandler(console)
82
85
class AvahiError(Exception):
83
86
def __init__(self, value):
85
super(AvahiError, self).__init__()
87
89
return repr(self.value)
96
98
class AvahiService(object):
97
"""An Avahi (Zeroconf) service.
99
100
interface: integer; avahi.IF_UNSPEC or an interface index.
100
101
Used to optionally bind to the specified interface.
101
name: string; Example: 'Mandos'
102
type: string; Example: '_mandos._tcp'.
103
See <http://www.dns-sd.org/ServiceTypes.html>
104
port: integer; what port to announce
105
TXT: list of strings; TXT record for the service
106
domain: string; Domain to publish on, default to .local if empty.
107
host: string; Host to publish records for, default is localhost
108
max_renames: integer; maximum number of renames
109
rename_count: integer; counter so we only rename after collisions
110
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
112
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
113
servicetype = None, port = None, TXT = None, domain = "",
114
host = "", max_renames = 32768):
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
115
118
self.interface = interface
117
self.type = servicetype
123
126
self.domain = domain
125
128
self.rename_count = 0
126
self.max_renames = max_renames
127
129
def rename(self):
128
130
"""Derived from the Avahi example code"""
129
131
if self.rename_count >= self.max_renames:
130
logger.critical(u"No suitable Zeroconf service name found"
131
u" after %i retries, exiting.",
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
133
134
raise AvahiServiceError("Too many renames")
134
self.name = server.GetAlternativeServiceName(self.name)
135
logger.info(u"Changing Zeroconf service name to %r ...",
137
syslogger.setFormatter(logging.Formatter\
138
('Mandos (%s): %%(levelname)s:'
139
' %%(message)s' % self.name))
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
142
139
self.rename_count += 1
154
151
avahi.DBUS_INTERFACE_ENTRY_GROUP)
155
152
group.connect_to_signal('StateChanged',
156
153
entry_group_state_changed)
157
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
154
logger.debug(u"Adding service '%s' of type '%s' ...",
158
155
service.name, service.type)
159
156
group.AddService(
160
157
self.interface, # interface
224
221
interval = property(lambda self: self._interval,
226
223
del _set_interval
227
def __init__(self, name = None, stop_hook=None, config=None):
228
"""Note: the 'checker' key in 'config' sets the
229
'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.."""
234
230
logger.debug(u"Creating client %r", self.name)
235
# Uppercase and remove spaces from fingerprint for later
236
# comparison purposes with return value from the fingerprint()
238
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"")
240
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
241
if "secret" in config:
242
self.secret = config["secret"].decode(u"base64")
243
elif "secfile" in config:
244
with closing(open(os.path.expanduser
246
(config["secfile"])))) \
248
self.secret = secfile.read()
237
self.secret = secret.decode(u"base64")
240
self.secret = sf.read()
250
243
raise TypeError(u"No secret or secfile for client %s"
252
self.host = config.get("host", "")
253
246
self.created = datetime.datetime.now()
254
247
self.last_checked_ok = None
255
self.timeout = string_to_delta(config["timeout"])
256
self.interval = string_to_delta(config["interval"])
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
257
250
self.stop_hook = stop_hook
258
251
self.checker = None
259
252
self.checker_initiator_tag = None
260
253
self.stop_initiator_tag = None
261
254
self.checker_callback_tag = None
262
self.check_command = config["checker"]
255
self.check_command = checker
264
257
"""Start this client's checker and timeout hooks"""
265
258
# Schedule a new checker to be started an 'interval' from now,
300
293
def checker_callback(self, pid, condition):
301
294
"""The checker has completed, so take appropriate actions."""
295
now = datetime.datetime.now()
302
296
self.checker_callback_tag = None
303
297
self.checker = None
304
298
if os.WIFEXITED(condition) \
305
299
and (os.WEXITSTATUS(condition) == 0):
306
logger.info(u"Checker for %(name)s succeeded",
300
logger.debug(u"Checker for %(name)s succeeded",
302
self.last_checked_ok = now
303
gobject.source_remove(self.stop_initiator_tag)
304
self.stop_initiator_tag = gobject.timeout_add\
305
(self._timeout_milliseconds,
309
307
elif not os.WIFEXITED(condition):
310
308
logger.warning(u"Checker for %(name)s crashed?",
313
logger.info(u"Checker for %(name)s failed",
315
def bump_timeout(self):
316
"""Bump up the timeout for this client.
317
This should only be called when the client has been seen,
320
self.last_checked_ok = datetime.datetime.now()
321
gobject.source_remove(self.stop_initiator_tag)
322
self.stop_initiator_tag = gobject.timeout_add\
323
(self._timeout_milliseconds, self.stop)
311
logger.debug(u"Checker for %(name)s failed",
324
313
def start_checker(self):
325
314
"""Start a new checker subprocess if one is not running.
326
315
If a checker already exists, leave it running and do
349
338
u' %s', self.check_command, error)
350
339
return True # Try again later
352
logger.info(u"Starting checker %r for %s",
354
# We don't need to redirect stdout and stderr, since
355
# in normal mode, that is already done by daemon(),
356
# and in debug mode we don't want to. (Stdin is
357
# always replaced by /dev/null.)
341
logger.debug(u"Starting checker %r for %s",
358
343
self.checker = subprocess.Popen(command,
360
345
shell=True, cwd="/")
361
346
self.checker_callback_tag = gobject.child_watch_add\
362
347
(self.checker.pid,
363
348
self.checker_callback)
364
except OSError, error:
349
except subprocess.OSError, error:
365
350
logger.error(u"Failed to start subprocess: %s",
367
352
# Re-run this periodically if run by gobject.timeout_add
412
397
def fingerprint(openpgp):
413
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\
414
403
# New GnuTLS "datum" with the OpenPGP public key
415
404
datum = gnutls.library.types.gnutls_datum_t\
416
405
(ctypes.cast(ctypes.c_char_p(openpgp),
417
406
ctypes.POINTER(ctypes.c_ubyte)),
418
407
ctypes.c_uint(len(openpgp)))
419
# New empty GnuTLS certificate
420
crt = gnutls.library.types.gnutls_openpgp_crt_t()
421
gnutls.library.functions.gnutls_openpgp_crt_init\
423
408
# Import the OpenPGP public key into the certificate
424
gnutls.library.functions.gnutls_openpgp_crt_import\
425
(crt, ctypes.byref(datum),
426
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
427
# Verify the self signature in the key
428
crtverify = ctypes.c_uint()
429
gnutls.library.functions.gnutls_openpgp_crt_verify_self\
430
(crt, 0, ctypes.byref(crtverify))
431
if crtverify.value != 0:
432
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
433
raise gnutls.errors.CertificateSecurityError("Verify failed")
409
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
412
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
434
413
# New buffer for the fingerprint
435
buf = ctypes.create_string_buffer(20)
436
buf_len = ctypes.c_size_t()
414
buffer = ctypes.create_string_buffer(20)
415
buffer_length = ctypes.c_size_t()
437
416
# Get the fingerprint from the certificate into the buffer
438
417
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
439
(crt, ctypes.byref(buf), ctypes.byref(buf_len))
418
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
440
419
# Deinit the certificate
441
420
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
442
421
# Convert the buffer to a Python bytestring
443
fpr = ctypes.string_at(buf, buf_len.value)
422
fpr = ctypes.string_at(buffer, buffer_length.value)
444
423
# Convert the bytestring to hexadecimal notation
445
424
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
449
class TCP_handler(SocketServer.BaseRequestHandler, object):
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
450
429
"""A TCP request handler class.
451
430
Instantiated by IPv6_TCPServer for each request to handle it.
452
431
Note: This will run in its own forked process."""
454
433
def handle(self):
455
logger.info(u"TCP connection from: %s",
456
unicode(self.client_address))
457
session = gnutls.connection.ClientSession\
458
(self.request, gnutls.connection.X509Credentials())
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
460
437
line = self.request.makefile().readline()
461
438
logger.debug(u"Protocol version: %r", line)
474
453
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
475
454
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
477
# Use a fallback default, since this MUST be set.
478
priority = self.server.settings.get("priority", "NORMAL")
456
priority = "NORMAL" # Fallback default, since this
458
if self.server.settings["priority"]:
459
priority = self.server.settings["priority"]
479
460
gnutls.library.functions.gnutls_priority_set_direct\
480
(session._c_object, priority, None)
461
(session._c_object, priority, None);
483
464
session.handshake()
484
465
except gnutls.errors.GNUTLSError, error:
485
logger.warning(u"Handshake failed: %s", error)
466
logger.debug(u"Handshake failed: %s", error)
486
467
# Do not run session.bye() here: the session is not
487
468
# established. Just abandon the request.
490
471
fpr = fingerprint(peer_certificate(session))
491
472
except (TypeError, gnutls.errors.GNUTLSError), error:
492
logger.warning(u"Bad certificate: %s", error)
473
logger.debug(u"Bad certificate: %s", error)
495
476
logger.debug(u"Fingerprint: %s", fpr)
502
logger.warning(u"Client not found for fingerprint: %s",
483
logger.debug(u"Client not found for fingerprint: %s", fpr)
506
486
# Have to check if client.still_valid(), since it is possible
507
487
# that the client timed out while establishing the GnuTLS
509
489
if not client.still_valid():
510
logger.warning(u"Client %(name)s is invalid",
490
logger.debug(u"Client %(name)s is invalid", vars(client))
514
## This won't work here, since we're in a fork.
515
# client.bump_timeout()
517
494
while sent_size < len(client.secret):
518
495
sent = session.send(client.secret[sent_size:])
526
class IPv6_TCPServer(SocketServer.ForkingMixIn,
527
SocketServer.TCPServer, object):
503
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
528
504
"""IPv6 TCP server. Accepts 'None' as address and/or port.
530
506
settings: Server settings
531
507
clients: Set() of Client objects
532
enabled: Boolean; whether this server is activated yet
534
509
address_family = socket.AF_INET6
535
510
def __init__(self, *args, **kwargs):
554
528
self.settings["interface"])
555
529
except socket.error, error:
556
530
if error[0] == errno.EPERM:
557
logger.error(u"No permission to"
558
u" bind to interface %s",
559
self.settings["interface"])
531
logger.warning(u"No permission to"
532
u" bind to interface %s",
533
self.settings["interface"])
562
536
# Only bind(2) the socket if we really need to.
565
539
in6addr_any = "::"
566
540
self.server_address = (in6addr_any,
567
541
self.server_address[1])
568
elif not self.server_address[1]:
542
elif self.server_address[1] is None:
569
543
self.server_address = (self.server_address[0],
571
# if self.settings["interface"]:
572
# self.server_address = (self.server_address[0],
578
return super(IPv6_TCPServer, self).server_bind()
579
def server_activate(self):
581
return super(IPv6_TCPServer, self).server_activate()
545
return super(type(self), self).server_bind()
586
548
def string_to_delta(interval):
596
558
datetime.timedelta(1)
597
559
>>> string_to_delta(u'1w')
598
560
datetime.timedelta(7)
599
>>> string_to_delta('5m 30s')
600
datetime.timedelta(0, 330)
602
timevalue = datetime.timedelta(0)
603
for s in interval.split():
605
suffix = unicode(s[-1])
608
delta = datetime.timedelta(value)
610
delta = datetime.timedelta(0, value)
612
delta = datetime.timedelta(0, 0, 0, 0, value)
614
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
616
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
619
except (ValueError, IndexError):
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)
577
except (ValueError, IndexError):
625
582
def server_state_changed(state):
626
583
"""Derived from the Avahi example code"""
627
584
if state == avahi.SERVER_COLLISION:
628
logger.error(u"Zeroconf server name collision")
585
logger.warning(u"Server name collision")
630
587
elif state == avahi.SERVER_RUNNING:
634
591
def entry_group_state_changed(state, error):
635
592
"""Derived from the Avahi example code"""
636
logger.debug(u"Avahi state change: %i", state)
593
logger.debug(u"state change: %i", state)
638
595
if state == avahi.ENTRY_GROUP_ESTABLISHED:
639
logger.debug(u"Zeroconf service established.")
596
logger.debug(u"Service established.")
640
597
elif state == avahi.ENTRY_GROUP_COLLISION:
641
logger.warning(u"Zeroconf service name collision.")
598
logger.warning(u"Service name collision.")
643
600
elif state == avahi.ENTRY_GROUP_FAILURE:
644
logger.critical(u"Avahi: Error in group state changed %s",
601
logger.critical(u"Error in group state changed %s",
646
603
raise AvahiGroupError("State changed: %s", str(error))
659
618
def if_nametoindex(interface):
660
619
"Get an interface index the hard way, i.e. using fcntl()"
661
620
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
662
with closing(socket.socket()) as s:
663
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
664
struct.pack("16s16x", interface))
622
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
623
struct.pack("16s16x", interface))
665
625
interface_index = struct.unpack("I", ifreq[16:20])[0]
666
626
return interface_index
667
627
return if_nametoindex(interface)
670
def daemon(nochdir = False, noclose = False):
630
def daemon(nochdir, noclose):
671
631
"""See daemon(3). Standard BSD Unix function.
672
632
This should really exist as os.daemon, but it doesn't (yet)."""
700
661
help="Port number to receive requests on")
701
662
parser.add_option("--check", action="store_true", default=False,
702
663
help="Run self-test")
703
parser.add_option("--debug", action="store_true",
664
parser.add_option("--debug", action="store_true", default=False,
704
665
help="Debug mode; run in foreground and log to"
706
667
parser.add_option("--priority", type="string", help="GnuTLS"
731
692
# Parse config file for server-global settings
732
693
server_config = ConfigParser.SafeConfigParser(server_defaults)
733
694
del server_defaults
734
server_config.read(os.path.join(options.configdir, "mandos.conf"))
695
server_config.read(os.path.join(options.configdir, "server.conf"))
696
server_section = "server"
735
697
# Convert the SafeConfigParser object to a dict
736
server_settings = server_config.defaults()
698
server_settings = dict(server_config.items(server_section))
737
699
# Use getboolean on the boolean config option
738
700
server_settings["debug"] = server_config.getboolean\
701
(server_section, "debug")
740
702
del server_config
742
704
# Override the settings from the config file with command line
750
712
# Now we have our good server settings in "server_settings"
752
debug = server_settings["debug"]
755
syslogger.setLevel(logging.WARNING)
756
console.setLevel(logging.WARNING)
758
if server_settings["servicename"] != "Mandos":
759
syslogger.setFormatter(logging.Formatter\
760
('Mandos (%s): %%(levelname)s:'
762
% server_settings["servicename"]))
764
714
# Parse config file with clients
765
715
client_defaults = { "timeout": "1h",
766
716
"interval": "5m",
767
"checker": "fping -q -- %(host)s",
717
"checker": "fping -q -- %%(fqdn)s",
770
719
client_config = ConfigParser.SafeConfigParser(client_defaults)
771
720
client_config.read(os.path.join(server_settings["configdir"],
775
tcp_server = IPv6_TCPServer((server_settings["address"],
776
server_settings["port"]),
778
settings=server_settings,
780
pidfilename = "/var/run/mandos.pid"
782
pidfile = open(pidfilename, "w")
783
except IOError, error:
784
logger.error("Could not open file %r", pidfilename)
789
uid = pwd.getpwnam("mandos").pw_uid
792
uid = pwd.getpwnam("nobody").pw_uid
796
gid = pwd.getpwnam("mandos").pw_gid
799
gid = pwd.getpwnam("nogroup").pw_gid
805
except OSError, error:
806
if error[0] != errno.EPERM:
810
724
service = AvahiService(name = server_settings["servicename"],
811
servicetype = "_mandos._tcp", )
725
type = "_mandos._tcp", );
812
726
if server_settings["interface"]:
813
service.interface = if_nametoindex\
814
(server_settings["interface"])
727
service.interface = if_nametoindex(server_settings["interface"])
820
733
DBusGMainLoop(set_as_default=True )
821
734
main_loop = gobject.MainLoop()
822
735
bus = dbus.SystemBus()
823
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
824
avahi.DBUS_PATH_SERVER),
825
avahi.DBUS_INTERFACE_SERVER)
736
server = dbus.Interface(
737
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
738
avahi.DBUS_INTERFACE_SERVER )
826
739
# 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)
828
752
def remove_from_clients(client):
829
753
clients.remove(client)
831
logger.critical(u"No clients left, exiting")
755
logger.debug(u"No clients left, exiting")
834
clients.update(Set(Client(name = section,
758
clients.update(Set(Client(name=section,
835
759
stop_hook = remove_from_clients,
837
= dict(client_config.items(section)))
760
**(dict(client_config\
838
762
for section in client_config.sections()))
840
logger.critical(u"No clients defined")
844
# Redirect stdin so all checkers get /dev/null
845
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
846
os.dup2(null, sys.stdin.fileno())
851
logger.removeHandler(console)
852
# Close all input and output, do double fork, etc.
857
pidfile.write(str(pid) + "\n")
861
logger.error(u"Could not write to file %r with PID %d",
864
# "pidfile" was never created
869
768
"Cleanup function; run on exit"
889
788
for client in clients:
893
tcp_server.server_activate()
791
tcp_server = IPv6_TCPServer((server_settings["address"],
792
server_settings["port"]),
794
settings=server_settings,
895
796
# Find out what port we got
896
797
service.port = tcp_server.socket.getsockname()[1]
897
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
898
u" scope_id %d" % tcp_server.socket.getsockname())
798
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
799
u" scope_id %d" % tcp_server.socket.getsockname())
900
801
#service.interface = tcp_server.socket.getsockname()[3]