61
28
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
logger = logging.Logger('mandos')
77
syslogger = logging.handlers.SysLogHandler\
78
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
79
syslogger.setFormatter(logging.Formatter\
80
('%(levelname)s: %(message)s'))
81
logger.addHandler(syslogger)
85
class AvahiError(Exception):
86
def __init__(self, value):
89
return repr(self.value)
91
class AvahiServiceError(AvahiError):
94
class AvahiGroupError(AvahiError):
98
class AvahiService(object):
100
interface: integer; avahi.IF_UNSPEC or an interface index.
101
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
114
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. """
118
self.interface = interface
128
self.rename_count = 0
130
"""Derived from the Avahi example code"""
131
if self.rename_count >= self.max_renames:
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
134
raise AvahiServiceError("Too many renames")
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
139
self.rename_count += 1
141
"""Derived from the Avahi example code"""
142
if group is not None:
145
"""Derived from the Avahi example code"""
148
group = dbus.Interface\
149
(bus.get_object(avahi.DBUS_NAME,
150
server.EntryGroupNew()),
151
avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
group.connect_to_signal('StateChanged',
153
entry_group_state_changed)
154
logger.debug(u"Adding service '%s' of type '%s' ...",
155
service.name, service.type)
157
self.interface, # interface
158
avahi.PROTO_INET6, # protocol
159
dbus.UInt32(0), # flags
160
self.name, self.type,
161
self.domain, self.host,
162
dbus.UInt16(self.port),
163
avahi.string_array_to_txt_array(self.TXT))
166
# From the Avahi example code:
167
group = None # our entry group
31
# This variable is used to optionally bind to a specified interface.
32
# It is a global variable to fit in with the other variables from the
33
# Avahi server example code.
34
serviceInterface = avahi.IF_UNSPEC
35
# From the Avahi server example code:
36
serviceName = "Mandos"
37
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
38
servicePort = None # Not known at startup
39
serviceTXT = [] # TXT record for the service
40
domain = "" # Domain to publish on, default to .local
41
host = "" # Host to publish records for, default to localhost
42
group = None #our entry group
43
rename_count = 12 # Counter so we only rename after collisions a
44
# sensible number of times
168
45
# End of Avahi example code
176
53
uniquely identify the client
177
54
secret: bytestring; sent verbatim (over TLS) to client
178
55
fqdn: string (FQDN); available for use by the checker command
179
created: datetime.datetime(); object creation, not client host
180
last_checked_ok: datetime.datetime() or None if not yet checked OK
181
timeout: datetime.timedelta(); How long from last_checked_ok
182
until this client is invalid
56
created: datetime.datetime()
57
last_seen: datetime.datetime() or None if not yet seen
58
timeout: datetime.timedelta(); How long from last_seen until
59
this client is invalid
183
60
interval: datetime.timedelta(); How often to start a new checker
184
61
stop_hook: If set, called by stop() as stop_hook(self)
185
62
checker: subprocess.Popen(); a running checker process used
186
63
to see if the client lives.
187
'None' if no process is running.
64
Is None if no process is running.
188
65
checker_initiator_tag: a gobject event source tag, or None
189
66
stop_initiator_tag: - '' -
190
67
checker_callback_tag: - '' -
191
68
checker_command: string; External command which is run to check if
192
client lives. %() expansions are done at
69
client lives. %()s expansions are done at
193
70
runtime with vars(self) as dict, so that for
194
71
instance %(name)s can be used in the command.
195
72
Private attibutes:
196
73
_timeout: Real variable for 'timeout'
197
74
_interval: Real variable for 'interval'
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
75
_timeout_milliseconds: Used by gobject.timeout_add()
199
76
_interval_milliseconds: - '' -
201
78
def _set_timeout(self, timeout):
288
164
# Do not run this again if called by a gobject.timeout_add
290
166
def __del__(self):
291
self.stop_hook = None
167
# Some code duplication here and in stop()
168
if hasattr(self, "stop_initiator_tag") \
169
and self.stop_initiator_tag:
170
gobject.source_remove(self.stop_initiator_tag)
171
self.stop_initiator_tag = None
172
if hasattr(self, "checker_initiator_tag") \
173
and self.checker_initiator_tag:
174
gobject.source_remove(self.checker_initiator_tag)
175
self.checker_initiator_tag = None
293
177
def checker_callback(self, pid, condition):
294
178
"""The checker has completed, so take appropriate actions."""
295
179
now = datetime.datetime.now()
296
self.checker_callback_tag = None
298
180
if os.WIFEXITED(condition) \
299
181
and (os.WEXITSTATUS(condition) == 0):
300
logger.debug(u"Checker for %(name)s succeeded",
302
self.last_checked_ok = now
183
sys.stderr.write(u"Checker for %(name)s succeeded\n"
303
186
gobject.source_remove(self.stop_initiator_tag)
304
187
self.stop_initiator_tag = gobject.timeout_add\
305
188
(self._timeout_milliseconds,
307
elif not os.WIFEXITED(condition):
308
logger.warning(u"Checker for %(name)s crashed?",
311
logger.debug(u"Checker for %(name)s failed",
191
if not os.WIFEXITED(condition):
192
sys.stderr.write(u"Checker for %(name)s crashed?\n"
195
sys.stderr.write(u"Checker for %(name)s failed\n"
198
self.checker_callback_tag = None
313
199
def start_checker(self):
314
200
"""Start a new checker subprocess if one is not running.
315
201
If a checker already exists, leave it running and do
317
# The reason for not killing a running checker is that if we
318
# did that, then if a checker (for some reason) started
319
# running slowly and taking more than 'interval' time, the
320
# client would inevitably timeout, since no checker would get
321
# a chance to run to completion. If we instead leave running
322
# checkers alone, the checker would have to take more time
323
# than 'timeout' for the client to be declared invalid, which
324
# is as it should be.
325
203
if self.checker is None:
205
sys.stderr.write(u"Starting checker for %s\n"
327
# In case check_command has exactly one % operator
328
208
command = self.check_command % self.fqdn
329
209
except TypeError:
330
# Escape attributes for the shell
331
210
escaped_attrs = dict((key, re.escape(str(val)))
333
212
vars(self).iteritems())
335
command = self.check_command % escaped_attrs
336
except TypeError, error:
337
logger.error(u'Could not format string "%s":'
338
u' %s', self.check_command, error)
339
return True # Try again later
213
command = self.check_command % escaped_attrs
341
logger.debug(u"Starting checker %r for %s",
343
self.checker = subprocess.Popen(command,
346
self.checker_callback_tag = gobject.child_watch_add\
348
self.checker_callback)
215
self.checker = subprocess.\
217
stdout=subprocess.PIPE,
218
close_fds=True, shell=True,
220
self.checker_callback_tag = gobject.\
221
child_watch_add(self.checker.pid,
349
224
except subprocess.OSError, error:
350
logger.error(u"Failed to start subprocess: %s",
225
sys.stderr.write(u"Failed to start subprocess: %s\n"
352
227
# Re-run this periodically if run by gobject.timeout_add
354
229
def stop_checker(self):
355
230
"""Force the checker process, if any, to stop."""
356
if self.checker_callback_tag:
357
gobject.source_remove(self.checker_callback_tag)
358
self.checker_callback_tag = None
359
if getattr(self, "checker", None) is None:
231
if not hasattr(self, "checker") or self.checker is None:
361
logger.debug("Stopping checker for %(name)s", vars(self))
363
os.kill(self.checker.pid, signal.SIGTERM)
365
#if self.checker.poll() is None:
366
# os.kill(self.checker.pid, signal.SIGKILL)
367
except OSError, error:
368
if error.errno != errno.ESRCH: # No such process
233
gobject.source_remove(self.checker_callback_tag)
234
self.checker_callback_tag = None
235
os.kill(self.checker.pid, signal.SIGTERM)
236
if self.checker.poll() is None:
237
os.kill(self.checker.pid, signal.SIGKILL)
370
238
self.checker = None
371
def still_valid(self):
239
def still_valid(self, now=None):
372
240
"""Has the timeout not yet passed for this client?"""
373
now = datetime.datetime.now()
374
if self.last_checked_ok is None:
242
now = datetime.datetime.now()
243
if self.last_seen is None:
375
244
return now < (self.created + self.timeout)
377
return now < (self.last_checked_ok + self.timeout)
246
return now < (self.last_seen + self.timeout)
380
249
def peer_certificate(session):
381
"Return the peer's OpenPGP certificate as a bytestring"
382
250
# If not an OpenPGP certificate...
383
251
if gnutls.library.functions.gnutls_certificate_type_get\
384
252
(session._c_object) \
431
298
Note: This will run in its own forked process."""
433
300
def handle(self):
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
437
line = self.request.makefile().readline()
438
logger.debug(u"Protocol version: %r", line)
440
if int(line.strip().split()[0]) > 1:
442
except (ValueError, IndexError, RuntimeError), error:
443
logger.error(u"Unknown protocol version: %s", error)
446
session = gnutls.connection.ClientSession\
447
(self.request, gnutls.connection.X509Credentials())
448
# Note: gnutls.connection.X509Credentials is really a generic
449
# GnuTLS certificate credentials object so long as no X.509
450
# keys are added to it. Therefore, we can use it here despite
451
# using OpenPGP certificates.
302
sys.stderr.write(u"TCP request came\n")
303
sys.stderr.write(u"Request: %s\n" % self.request)
304
sys.stderr.write(u"Client Address: %s\n"
305
% unicode(self.client_address))
306
sys.stderr.write(u"Server: %s\n" % self.server)
307
session = gnutls.connection.ClientSession(self.request,
453
311
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
454
312
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
456
priority = "NORMAL" # Fallback default, since this
458
if self.server.settings["priority"]:
459
priority = self.server.settings["priority"]
314
priority = "SECURE256"
460
316
gnutls.library.functions.gnutls_priority_set_direct\
461
317
(session._c_object, priority, None);
464
320
session.handshake()
465
321
except gnutls.errors.GNUTLSError, error:
466
logger.debug(u"Handshake failed: %s", error)
323
sys.stderr.write(u"Handshake failed: %s\n" % error)
467
324
# Do not run session.bye() here: the session is not
468
325
# established. Just abandon the request.
471
328
fpr = fingerprint(peer_certificate(session))
472
329
except (TypeError, gnutls.errors.GNUTLSError), error:
473
logger.debug(u"Bad certificate: %s", error)
331
sys.stderr.write(u"Bad certificate: %s\n" % error)
476
logger.debug(u"Fingerprint: %s", fpr)
335
sys.stderr.write(u"Fingerprint: %s\n" % fpr)
478
for c in self.server.clients:
479
338
if c.fingerprint == fpr:
483
logger.debug(u"Client not found for fingerprint: %s", fpr)
486
341
# Have to check if client.still_valid(), since it is possible
487
342
# that the client timed out while establishing the GnuTLS
489
if not client.still_valid():
490
logger.debug(u"Client %(name)s is invalid", vars(client))
344
if (not client) or (not client.still_valid()):
347
sys.stderr.write(u"Client %(name)s is invalid\n"
350
sys.stderr.write(u"Client not found for "
351
u"fingerprint: %s\n" % fpr)
494
355
while sent_size < len(client.secret):
495
356
sent = session.send(client.secret[sent_size:])
496
logger.debug(u"Sent: %d, remaining: %d",
497
sent, len(client.secret)
498
- (sent_size + sent))
358
sys.stderr.write(u"Sent: %d, remaining: %d\n"
359
% (sent, len(client.secret)
360
- (sent_size + sent)))
499
361
sent_size += sent
446
"""From the Avahi server example code"""
447
global group, serviceName, serviceType, servicePort, serviceTXT, \
450
group = dbus.Interface(
451
bus.get_object( avahi.DBUS_NAME,
452
server.EntryGroupNew()),
453
avahi.DBUS_INTERFACE_ENTRY_GROUP)
454
group.connect_to_signal('StateChanged',
455
entry_group_state_changed)
457
sys.stderr.write(u"Adding service '%s' of type '%s' ...\n"
458
% (serviceName, serviceType))
461
serviceInterface, # interface
462
avahi.PROTO_INET6, # protocol
463
dbus.UInt32(0), # flags
464
serviceName, serviceType,
466
dbus.UInt16(servicePort),
467
avahi.string_array_to_txt_array(serviceTXT))
471
def remove_service():
472
"""From the Avahi server example code"""
475
if not group is None:
582
479
def server_state_changed(state):
583
"""Derived from the Avahi example code"""
480
"""From the Avahi server example code"""
584
481
if state == avahi.SERVER_COLLISION:
585
logger.warning(u"Server name collision")
482
sys.stderr.write(u"WARNING: Server name collision\n")
587
484
elif state == avahi.SERVER_RUNNING:
591
488
def entry_group_state_changed(state, error):
592
"""Derived from the Avahi example code"""
593
logger.debug(u"state change: %i", state)
489
"""From the Avahi server example code"""
490
global serviceName, server, rename_count
493
sys.stderr.write(u"state change: %i\n" % state)
595
495
if state == avahi.ENTRY_GROUP_ESTABLISHED:
596
logger.debug(u"Service established.")
497
sys.stderr.write(u"Service established.\n")
597
498
elif state == avahi.ENTRY_GROUP_COLLISION:
598
logger.warning(u"Service name collision.")
500
rename_count = rename_count - 1
502
name = server.GetAlternativeServiceName(name)
503
sys.stderr.write(u"WARNING: Service name collision, "
504
u"changing name to '%s' ...\n" % name)
509
sys.stderr.write(u"ERROR: No suitable service name found "
510
u"after %i retries, exiting.\n"
600
513
elif state == avahi.ENTRY_GROUP_FAILURE:
601
logger.critical(u"Error in group state changed %s",
603
raise AvahiGroupError("State changed: %s", str(error))
605
def if_nametoindex(interface, _func=[None]):
606
"""Call the C function if_nametoindex(), or equivalent"""
607
if _func[0] is not None:
608
return _func[0](interface)
514
sys.stderr.write(u"Error in group state changed %s\n"
520
def if_nametoindex(interface):
521
"""Call the C function if_nametoindex()"""
610
if "ctypes.util" not in sys.modules:
614
libc = ctypes.cdll.LoadLibrary\
615
(ctypes.util.find_library("c"))
616
_func[0] = libc.if_nametoindex
617
return _func[0](interface)
523
libc = ctypes.cdll.LoadLibrary("libc.so.6")
524
return libc.if_nametoindex(interface)
621
525
except (OSError, AttributeError):
622
526
if "struct" not in sys.modules:
624
528
if "fcntl" not in sys.modules:
626
def the_hard_way(interface):
627
"Get an interface index the hard way, i.e. using fcntl()"
628
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
630
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
631
struct.pack("16s16x", interface))
633
interface_index = struct.unpack("I", ifreq[16:20])[0]
634
return interface_index
635
_func[0] = the_hard_way
636
return _func[0](interface)
639
def daemon(nochdir, noclose):
640
"""See daemon(3). Standard BSD Unix function.
641
This should really exist as os.daemon, but it doesn't (yet)."""
648
# Close all standard open file descriptors
649
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
650
if not stat.S_ISCHR(os.fstat(null).st_mode):
651
raise OSError(errno.ENODEV,
652
"/dev/null not a character device")
653
os.dup2(null, sys.stdin.fileno())
654
os.dup2(null, sys.stdout.fileno())
655
os.dup2(null, sys.stderr.fileno())
661
global main_loop_started
662
main_loop_started = False
530
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
532
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
533
struct.pack("16s16x", interface))
535
interface_index = struct.unpack("I", ifreq[16:20])[0]
536
return interface_index
539
if __name__ == '__main__':
664
540
parser = OptionParser()
665
541
parser.add_option("-i", "--interface", type="string",
666
metavar="IF", help="Bind to interface IF")
667
parser.add_option("-a", "--address", type="string",
668
help="Address to listen for requests on")
669
parser.add_option("-p", "--port", type="int",
542
default=None, metavar="IF",
543
help="Bind to interface IF")
544
parser.add_option("--cert", type="string", default="cert.pem",
546
help="Public key certificate PEM file to use")
547
parser.add_option("--key", type="string", default="key.pem",
549
help="Private key PEM file to use")
550
parser.add_option("--ca", type="string", default="ca.pem",
552
help="Certificate Authority certificate PEM file to use")
553
parser.add_option("--crl", type="string", default="crl.pem",
555
help="Certificate Revokation List PEM file to use")
556
parser.add_option("-p", "--port", type="int", default=None,
670
557
help="Port number to receive requests on")
558
parser.add_option("--timeout", type="string", # Parsed later
560
help="Amount of downtime allowed for clients")
561
parser.add_option("--interval", type="string", # Parsed later
563
help="How often to check that a client is up")
671
564
parser.add_option("--check", action="store_true", default=False,
672
565
help="Run self-test")
673
566
parser.add_option("--debug", action="store_true", default=False,
674
help="Debug mode; run in foreground and log to"
676
parser.add_option("--priority", type="string", help="GnuTLS"
677
" priority string (see GnuTLS documentation)")
678
parser.add_option("--servicename", type="string", metavar="NAME",
679
help="Zeroconf service name")
680
parser.add_option("--configdir", type="string",
681
default="/etc/mandos", metavar="DIR",
682
help="Directory to search for configuration"
684
568
(options, args) = parser.parse_args()
686
570
if options.check:
688
572
doctest.testmod()
691
# Default values for config file for server-global settings
692
server_defaults = { "interface": "",
697
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
698
"servicename": "Mandos",
701
# Parse config file for server-global settings
702
server_config = ConfigParser.SafeConfigParser(server_defaults)
704
server_config.read(os.path.join(options.configdir, "server.conf"))
705
server_section = "server"
706
# Convert the SafeConfigParser object to a dict
707
server_settings = dict(server_config.items(server_section))
708
# Use getboolean on the boolean config option
709
server_settings["debug"] = server_config.getboolean\
710
(server_section, "debug")
713
# Override the settings from the config file with command line
715
for option in ("interface", "address", "port", "debug",
716
"priority", "servicename", "configdir"):
717
value = getattr(options, option)
718
if value is not None:
719
server_settings[option] = value
721
# Now we have our good server settings in "server_settings"
723
# Parse config file with clients
724
client_defaults = { "timeout": "1h",
726
"checker": "fping -q -- %%(fqdn)s",
728
client_config = ConfigParser.SafeConfigParser(client_defaults)
729
client_config.read(os.path.join(server_settings["configdir"],
733
service = AvahiService(name = server_settings["servicename"],
734
type = "_mandos._tcp", );
735
if server_settings["interface"]:
736
service.interface = if_nametoindex(server_settings["interface"])
741
# From the Avahi example code
575
# Parse the time arguments
577
options.timeout = string_to_delta(options.timeout)
579
parser.error("option --timeout: Unparseable time")
581
options.interval = string_to_delta(options.interval)
583
parser.error("option --interval: Unparseable time")
586
defaults = { "checker": "sleep 1; fping -q -- %%(fqdn)s" }
587
client_config = ConfigParser.SafeConfigParser(defaults)
588
#client_config.readfp(open("secrets.conf"), "secrets.conf")
589
client_config.read("mandos-clients.conf")
591
# From the Avahi server example code
742
592
DBusGMainLoop(set_as_default=True )
743
593
main_loop = gobject.MainLoop()
744
594
bus = dbus.SystemBus()
747
597
avahi.DBUS_INTERFACE_SERVER )
748
598
# End of Avahi example code
750
debug = server_settings["debug"]
753
console = logging.StreamHandler()
754
# console.setLevel(logging.DEBUG)
755
console.setFormatter(logging.Formatter\
756
('%(levelname)s: %(message)s'))
757
logger.addHandler(console)
600
debug = options.debug
761
603
def remove_from_clients(client):
762
604
clients.remove(client)
764
logger.debug(u"No clients left, exiting")
607
sys.stderr.write(u"No clients left, exiting\n")
767
clients.update(Set(Client(name=section,
610
clients.update(Set(Client(name=section, options=options,
768
611
stop_hook = remove_from_clients,
769
612
**(dict(client_config\
770
613
.items(section))))
771
614
for section in client_config.sections()))
777
"Cleanup function; run on exit"
779
# From the Avahi example code
780
if not group is None:
783
# End of Avahi example code
786
client = clients.pop()
787
client.stop_hook = None
790
atexit.register(cleanup)
793
signal.signal(signal.SIGINT, signal.SIG_IGN)
794
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
795
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
797
615
for client in clients:
800
tcp_server = IPv6_TCPServer((server_settings["address"],
801
server_settings["port"]),
618
tcp_server = IPv6_TCPServer((None, options.port),
803
settings=server_settings,
805
# Find out what port we got
806
service.port = tcp_server.socket.getsockname()[1]
807
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
808
u" scope_id %d" % tcp_server.socket.getsockname())
810
#service.interface = tcp_server.socket.getsockname()[3]
622
# Find out what random port we got
623
servicePort = tcp_server.socket.getsockname()[1]
625
sys.stderr.write(u"Now listening on port %d\n" % servicePort)
627
if options.interface is not None:
628
serviceInterface = if_nametoindex(options.interface)
630
# From the Avahi server example code
631
server.connect_to_signal("StateChanged", server_state_changed)
632
server_state_changed(server.GetState())
633
# End of Avahi example code
635
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
636
lambda *args, **kwargs:
637
tcp_server.handle_request(*args[2:],
813
# From the Avahi example code
814
server.connect_to_signal("StateChanged", server_state_changed)
816
server_state_changed(server.GetState())
817
except dbus.exceptions.DBusException, error:
818
logger.critical(u"DBusException: %s", error)
820
# End of Avahi example code
822
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
823
lambda *args, **kwargs:
824
tcp_server.handle_request\
825
(*args[2:], **kwargs) or True)
827
logger.debug("Starting main loop")
828
main_loop_started = True
830
except AvahiError, error:
831
logger.critical(u"AvahiError: %s" + unicode(error))
833
641
except KeyboardInterrupt:
837
if __name__ == '__main__':
646
# From the Avahi server example code
647
if not group is None:
649
# End of Avahi example code
651
for client in clients:
652
client.stop_hook = None