2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos server - give out binary blobs to connecting clients.
6
# This program is partly derived from an example program for an Avahi
7
# service publisher, downloaded from
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
# following functions: "add_service", "remove_service",
10
# "server_state_changed", "entry_group_state_changed", and some lines
13
# Everything else is Copyright © 2007-2008 Teddy Hogeborn and Björn
16
# This program is free software: you can redistribute it and/or modify
17
# it under the terms of the GNU General Public License as published by
18
# the Free Software Foundation, either version 3 of the License, or
19
# (at your option) any later version.
21
# This program is distributed in the hope that it will be useful,
22
# but WITHOUT ANY WARRANTY; without even the implied warranty of
23
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24
# GNU General Public License for more details.
26
# You should have received a copy of the GNU General Public License
27
# along with this program. If not, see <http://www.gnu.org/licenses/>.
29
# Contact the authors at <https://www.fukt.bsnet.se/~belorn/> and
30
# <https://www.fukt.bsnet.se/~teddy/>.
3
33
from __future__ import division
19
52
from sets import Set
57
import logging.handlers
25
62
from dbus.mainloop.glib import DBusGMainLoop
27
# This variable is used to optionally bind to a specified
65
# Brief description of the operation of this program:
67
# This server announces itself as a Zeroconf service. Connecting
68
# clients use the TLS protocol, with the unusual quirk that this
69
# server program acts as a TLS "client" while the connecting clients
70
# acts as a TLS "server". The clients (acting as a TLS "server") must
71
# supply an OpenPGP certificate, and the fingerprint of this
72
# certificate is used by this server to look up (in a list read from a
73
# file at start time) which binary blob to give the client. No other
74
# authentication or authorization is done by this server.
77
logger = logging.Logger('mandos')
78
syslogger = logging.handlers.SysLogHandler\
79
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
80
syslogger.setFormatter(logging.Formatter\
81
('%(levelname)s: %(message)s'))
82
logger.addHandler(syslogger)
85
# This variable is used to optionally bind to a specified interface.
86
# It is a global variable to fit in with the other variables from the
29
88
serviceInterface = avahi.IF_UNSPEC
30
# It is a global variable to fit in with the rest of the
31
# variables from the Avahi server example code:
32
serviceName = "Mandos"
89
# From the Avahi example code:
33
91
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
34
92
servicePort = None # Not known at startup
35
93
serviceTXT = [] # TXT record for the service
44
102
class Client(object):
45
103
"""A representation of a client host served by this server.
48
fqdn: string, FQDN (used by the checker)
105
name: string; from the config file, used in log messages
106
fingerprint: string (40 or 32 hexadecimal digits); used to
107
uniquely identify the client
108
secret: bytestring; sent verbatim (over TLS) to client
109
fqdn: string (FQDN); available for use by the checker command
49
110
created: datetime.datetime()
50
111
last_seen: datetime.datetime() or None if not yet seen
51
112
timeout: datetime.timedelta(); How long from last_seen until
52
113
this client is invalid
53
114
interval: datetime.timedelta(); How often to start a new checker
54
timeout_milliseconds: Used by gobject.timeout_add()
55
interval_milliseconds: - '' -
56
115
stop_hook: If set, called by stop() as stop_hook(self)
57
116
checker: subprocess.Popen(); a running checker process used
58
117
to see if the client lives.
60
119
checker_initiator_tag: a gobject event source tag, or None
61
120
stop_initiator_tag: - '' -
62
121
checker_callback_tag: - '' -
122
checker_command: string; External command which is run to check if
123
client lives. %()s expansions are done at
124
runtime with vars(self) as dict, so that for
125
instance %(name)s can be used in the command.
127
_timeout: Real variable for 'timeout'
128
_interval: Real variable for 'interval'
129
_timeout_milliseconds: Used by gobject.timeout_add()
130
_interval_milliseconds: - '' -
64
def __init__(self, name=None, options=None, stop_hook=None,
65
dn=None, password=None, passfile=None, fqdn=None,
66
timeout=None, interval=-1):
132
def _set_timeout(self, timeout):
133
"Setter function for 'timeout' attribute"
134
self._timeout = timeout
135
self._timeout_milliseconds = ((self.timeout.days
136
* 24 * 60 * 60 * 1000)
137
+ (self.timeout.seconds * 1000)
138
+ (self.timeout.microseconds
140
timeout = property(lambda self: self._timeout,
143
def _set_interval(self, interval):
144
"Setter function for 'interval' attribute"
145
self._interval = interval
146
self._interval_milliseconds = ((self.interval.days
147
* 24 * 60 * 60 * 1000)
148
+ (self.interval.seconds
150
+ (self.interval.microseconds
152
interval = property(lambda self: self._interval,
155
def __init__(self, name=None, stop_hook=None, fingerprint=None,
156
secret=None, secfile=None, fqdn=None, timeout=None,
157
interval=-1, checker=None):
158
"""Note: the 'checker' argument sets the 'checker_command'
159
attribute and not the 'checker' attribute.."""
70
self.password = password
72
self.password = open(passfile).readall()
161
logger.debug(u"Creating client %r", self.name)
162
# Uppercase and remove spaces from fingerprint
163
# for later comparison purposes with return value of
164
# the fingerprint() function
165
self.fingerprint = fingerprint.upper().replace(u" ", u"")
166
logger.debug(u" Fingerprint: %s", self.fingerprint)
168
self.secret = secret.decode(u"base64")
171
self.secret = sf.read()
74
raise RuntimeError(u"No Password or Passfile for client %s"
174
raise RuntimeError(u"No secret or secfile for client %s"
76
176
self.fqdn = fqdn # string
77
177
self.created = datetime.datetime.now()
78
178
self.last_seen = None
80
timeout = options.timeout
81
self.timeout = timeout
82
self.timeout_milliseconds = ((self.timeout.days
83
* 24 * 60 * 60 * 1000)
84
+ (self.timeout.seconds * 1000)
85
+ (self.timeout.microseconds
88
interval = options.interval
90
interval = string_to_delta(interval)
91
self.interval = interval
92
self.interval_milliseconds = ((self.interval.days
93
* 24 * 60 * 60 * 1000)
94
+ (self.interval.seconds * 1000)
95
+ (self.interval.microseconds
179
self.timeout = string_to_delta(timeout)
180
self.interval = string_to_delta(interval)
97
181
self.stop_hook = stop_hook
98
182
self.checker = None
99
183
self.checker_initiator_tag = None
100
184
self.stop_initiator_tag = None
101
185
self.checker_callback_tag = None
186
self.check_command = checker
103
"""Start this clients checker and timeout hooks"""
188
"""Start this client's checker and timeout hooks"""
104
189
# Schedule a new checker to be started an 'interval' from now,
105
190
# and every interval from then on.
106
self.checker_initiator_tag = gobject.\
107
timeout_add(self.interval_milliseconds,
191
self.checker_initiator_tag = gobject.timeout_add\
192
(self._interval_milliseconds,
109
194
# Also start a new checker *right now*.
110
195
self.start_checker()
111
196
# Schedule a stop() when 'timeout' has passed
112
self.stop_initiator_tag = gobject.\
113
timeout_add(self.timeout_milliseconds,
197
self.stop_initiator_tag = gobject.timeout_add\
198
(self._timeout_milliseconds,
116
201
"""Stop this client.
117
202
The possibility that this client might be restarted is left
118
203
open, but not currently used."""
119
# print "Stopping client", self.name
121
if self.stop_initiator_tag:
204
# If this client doesn't have a secret, it is already stopped.
206
logger.debug(u"Stopping client %s", self.name)
210
if hasattr(self, "stop_initiator_tag") \
211
and self.stop_initiator_tag:
122
212
gobject.source_remove(self.stop_initiator_tag)
123
213
self.stop_initiator_tag = None
124
if self.checker_initiator_tag:
214
if hasattr(self, "checker_initiator_tag") \
215
and self.checker_initiator_tag:
125
216
gobject.source_remove(self.checker_initiator_tag)
126
217
self.checker_initiator_tag = None
127
218
self.stop_checker()
130
221
# Do not run this again if called by a gobject.timeout_add
132
223
def __del__(self):
133
# Some code duplication here and in stop()
134
if hasattr(self, "stop_initiator_tag") \
135
and self.stop_initiator_tag:
136
gobject.source_remove(self.stop_initiator_tag)
137
self.stop_initiator_tag = None
138
if hasattr(self, "checker_initiator_tag") \
139
and self.checker_initiator_tag:
140
gobject.source_remove(self.checker_initiator_tag)
141
self.checker_initiator_tag = None
224
self.stop_hook = None
143
226
def checker_callback(self, pid, condition):
144
227
"""The checker has completed, so take appropriate actions."""
145
228
now = datetime.datetime.now()
229
self.checker_callback_tag = None
146
231
if os.WIFEXITED(condition) \
147
232
and (os.WEXITSTATUS(condition) == 0):
148
#print "Checker for %(name)s succeeded" % vars(self)
233
logger.debug(u"Checker for %(name)s succeeded",
149
235
self.last_seen = now
150
236
gobject.source_remove(self.stop_initiator_tag)
151
self.stop_initiator_tag = gobject.\
152
timeout_add(self.timeout_milliseconds,
155
# if not os.WIFEXITED(condition):
156
# print "Checker for %(name)s crashed?" % vars(self)
158
# print "Checker for %(name)s failed" % vars(self)
160
self.checker_callback_tag = None
237
self.stop_initiator_tag = gobject.timeout_add\
238
(self._timeout_milliseconds,
240
elif not os.WIFEXITED(condition):
241
logger.warning(u"Checker for %(name)s crashed?",
244
logger.debug(u"Checker for %(name)s failed",
161
246
def start_checker(self):
162
247
"""Start a new checker subprocess if one is not running.
163
248
If a checker already exists, leave it running and do
250
# The reason for not killing a running checker is that if we
251
# did that, then if a checker (for some reason) started
252
# running slowly and taking more than 'interval' time, the
253
# client would inevitably timeout, since no checker would get
254
# a chance to run to completion. If we instead leave running
255
# checkers alone, the checker would have to take more time
256
# than 'timeout' for the client to be declared invalid, which
257
# is as it should be.
165
258
if self.checker is None:
166
#print "Starting checker for", self.name
260
command = self.check_command % self.fqdn
262
escaped_attrs = dict((key, re.escape(str(val)))
264
vars(self).iteritems())
266
command = self.check_command % escaped_attrs
267
except TypeError, error:
268
logger.critical(u'Could not format string "%s":'
269
u' %s', self.check_command, error)
270
return True # Try again later
272
logger.debug(u"Starting checker %r for %s",
168
274
self.checker = subprocess.\
169
Popen("sleep 1; fping -q -- %s"
170
% re.escape(self.fqdn),
171
stdout=subprocess.PIPE,
172
276
close_fds=True, shell=True,
174
self.checker_callback_tag = gobject.\
175
child_watch_add(self.checker.pid,
278
self.checker_callback_tag = gobject.child_watch_add\
280
self.checker_callback)
178
281
except subprocess.OSError, error:
179
sys.stderr.write(u"Failed to start subprocess: %s\n"
282
logger.error(u"Failed to start subprocess: %s",
181
284
# Re-run this periodically if run by gobject.timeout_add
183
286
def stop_checker(self):
184
287
"""Force the checker process, if any, to stop."""
288
if self.checker_callback_tag:
289
gobject.source_remove(self.checker_callback_tag)
290
self.checker_callback_tag = None
185
291
if not hasattr(self, "checker") or self.checker is None:
187
gobject.source_remove(self.checker_callback_tag)
188
self.checker_callback_tag = None
189
os.kill(self.checker.pid, signal.SIGTERM)
190
if self.checker.poll() is None:
191
os.kill(self.checker.pid, signal.SIGKILL)
293
logger.debug("Stopping checker for %(name)s", vars(self))
295
os.kill(self.checker.pid, signal.SIGTERM)
297
#if self.checker.poll() is None:
298
# os.kill(self.checker.pid, signal.SIGKILL)
299
except OSError, error:
300
if error.errno != errno.ESRCH:
192
302
self.checker = None
193
303
def still_valid(self, now=None):
194
304
"""Has the timeout not yet passed for this client?"""
200
310
return now < (self.last_seen + self.timeout)
313
def peer_certificate(session):
314
"Return the peer's OpenPGP certificate as a bytestring"
315
# If not an OpenPGP certificate...
316
if gnutls.library.functions.gnutls_certificate_type_get\
317
(session._c_object) \
318
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
319
# ...do the normal thing
320
return session.peer_certificate
321
list_size = ctypes.c_uint()
322
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
323
(session._c_object, ctypes.byref(list_size))
324
if list_size.value == 0:
327
return ctypes.string_at(cert.data, cert.size)
330
def fingerprint(openpgp):
331
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
332
# New empty GnuTLS certificate
333
crt = gnutls.library.types.gnutls_openpgp_crt_t()
334
gnutls.library.functions.gnutls_openpgp_crt_init\
336
# New GnuTLS "datum" with the OpenPGP public key
337
datum = gnutls.library.types.gnutls_datum_t\
338
(ctypes.cast(ctypes.c_char_p(openpgp),
339
ctypes.POINTER(ctypes.c_ubyte)),
340
ctypes.c_uint(len(openpgp)))
341
# Import the OpenPGP public key into the certificate
342
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
345
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
346
# New buffer for the fingerprint
347
buffer = ctypes.create_string_buffer(20)
348
buffer_length = ctypes.c_size_t()
349
# Get the fingerprint from the certificate into the buffer
350
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
351
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
352
# Deinit the certificate
353
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
354
# Convert the buffer to a Python bytestring
355
fpr = ctypes.string_at(buffer, buffer_length.value)
356
# Convert the bytestring to hexadecimal notation
357
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
203
361
class tcp_handler(SocketServer.BaseRequestHandler, object):
204
362
"""A TCP request handler class.
205
363
Instantiated by IPv6_TCPServer for each request to handle it.
206
364
Note: This will run in its own forked process."""
207
366
def handle(self):
208
#print u"TCP request came"
209
#print u"Request:", self.request
210
#print u"Client Address:", self.client_address
211
#print u"Server:", self.server
212
session = gnutls.connection.ServerSession(self.request,
367
logger.debug(u"TCP connection from: %s",
368
unicode(self.client_address))
369
session = gnutls.connection.ClientSession(self.request,
373
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
374
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
377
if self.server.options.priority:
378
priority = self.server.options.priority
379
gnutls.library.functions.gnutls_priority_set_direct\
380
(session._c_object, priority, None);
216
383
session.handshake()
217
384
except gnutls.errors.GNUTLSError, error:
218
#sys.stderr.write(u"Handshake failed: %s\n" % error)
385
logger.debug(u"Handshake failed: %s", error)
219
386
# Do not run session.bye() here: the session is not
220
387
# established. Just abandon the request.
222
#if session.peer_certificate:
223
# print "DN:", session.peer_certificate.subject
225
session.verify_peer()
226
except gnutls.errors.CertificateError, error:
227
#sys.stderr.write(u"Verify failed: %s\n" % error)
390
fpr = fingerprint(peer_certificate(session))
391
except (TypeError, gnutls.errors.GNUTLSError), error:
392
logger.debug(u"Bad certificate: %s", error)
395
logger.debug(u"Fingerprint: %s", fpr)
232
if c.dn == session.peer_certificate.subject:
397
for c in self.server.clients:
398
if c.fingerprint == fpr:
235
401
# Have to check if client.still_valid(), since it is possible
236
402
# that the client timed out while establishing the GnuTLS
238
if client and client.still_valid():
239
session.send(client.password)
242
# sys.stderr.write(u"Client %(name)s is invalid\n"
245
# sys.stderr.write(u"Client not found for DN: %s\n"
246
# % session.peer_certificate.subject)
247
#session.send("gazonk")
404
if (not client) or (not client.still_valid()):
406
logger.debug(u"Client %(name)s is invalid",
409
logger.debug(u"Client not found for fingerprint: %s",
414
while sent_size < len(client.secret):
415
sent = session.send(client.secret[sent_size:])
416
logger.debug(u"Sent: %d, remaining: %d",
417
sent, len(client.secret)
418
- (sent_size + sent))
369
536
def server_state_changed(state):
370
"""From the Avahi server example code"""
537
"""Derived from the Avahi example code"""
371
538
if state == avahi.SERVER_COLLISION:
372
print "WARNING: Server name collision"
539
logger.warning(u"Server name collision")
374
541
elif state == avahi.SERVER_RUNNING:
378
545
def entry_group_state_changed(state, error):
379
"""From the Avahi server example code"""
546
"""Derived from the Avahi example code"""
380
547
global serviceName, server, rename_count
382
# print "state change: %i" % state
549
logger.debug(u"state change: %i", state)
384
551
if state == avahi.ENTRY_GROUP_ESTABLISHED:
386
# print "Service established."
552
logger.debug(u"Service established.")
387
553
elif state == avahi.ENTRY_GROUP_COLLISION:
389
555
rename_count = rename_count - 1
390
556
if rename_count > 0:
391
557
name = server.GetAlternativeServiceName(name)
392
print "WARNING: Service name collision, changing name to '%s' ..." % name
558
logger.warning(u"Service name collision, "
559
u"changing name to '%s' ...", name)
397
print "ERROR: No suitable service name found after %i retries, exiting." % n_rename
564
logger.error(u"No suitable service name found after %i"
565
u" retries, exiting.", n_rename)
399
567
elif state == avahi.ENTRY_GROUP_FAILURE:
400
print "Error in group state changed", error
568
logger.error(u"Error in group state changed %s",
405
573
def if_nametoindex(interface):
406
574
"""Call the C function if_nametoindex()"""
408
if "ctypes" not in sys.modules:
410
576
libc = ctypes.cdll.LoadLibrary("libc.so.6")
411
577
return libc.if_nametoindex(interface)
412
except (ImportError, OSError, AttributeError):
578
except (OSError, AttributeError):
413
579
if "struct" not in sys.modules:
415
581
if "fcntl" not in sys.modules:
423
589
return interface_index
426
if __name__ == '__main__':
592
def daemon(nochdir, noclose):
593
"""See daemon(3). Standard BSD Unix function.
594
This should really exist as os.daemon, but it doesn't (yet)."""
601
# Close all standard open file descriptors
602
null = os.open("/dev/null", os.O_NOCTTY | os.O_RDWR)
603
if not stat.S_ISCHR(os.fstat(null).st_mode):
604
raise OSError(errno.ENODEV,
605
"/dev/null not a character device")
606
os.dup2(null, sys.stdin.fileno())
607
os.dup2(null, sys.stdout.fileno())
608
os.dup2(null, sys.stderr.fileno())
613
def killme(status = 0):
614
logger.debug("Stopping server with exit status %d", status)
616
if main_loop_started:
625
global main_loop_started
626
main_loop_started = False
427
628
parser = OptionParser()
428
629
parser.add_option("-i", "--interface", type="string",
429
630
default=None, metavar="IF",
430
631
help="Bind to interface IF")
431
parser.add_option("--cert", type="string", default="cert.pem",
433
help="Public key certificate PEM file to use")
434
parser.add_option("--key", type="string", default="key.pem",
436
help="Private key PEM file to use")
437
parser.add_option("--ca", type="string", default="ca.pem",
439
help="Certificate Authority certificate PEM file to use")
440
parser.add_option("--crl", type="string", default="crl.pem",
442
help="Certificate Revokation List PEM file to use")
632
parser.add_option("-a", "--address", type="string", default=None,
633
help="Address to listen for requests on")
443
634
parser.add_option("-p", "--port", type="int", default=None,
444
635
help="Port number to receive requests on")
445
parser.add_option("--timeout", type="string", # Parsed later
447
help="Amount of downtime allowed for clients")
448
parser.add_option("--interval", type="string", # Parsed later
450
help="How often to check that a client is up")
451
636
parser.add_option("--check", action="store_true", default=False,
452
637
help="Run self-test")
638
parser.add_option("--debug", action="store_true", default=False,
640
parser.add_option("--priority", type="string",
642
help="GnuTLS priority string"
643
" (see GnuTLS documentation)")
644
parser.add_option("--servicename", type="string",
645
default="Mandos", help="Zeroconf service name")
453
646
(options, args) = parser.parse_args()
455
648
if options.check:
457
650
doctest.testmod()
460
# Parse the time arguments
462
options.timeout = string_to_delta(options.timeout)
464
parser.error("option --timeout: Unparseable time")
466
options.interval = string_to_delta(options.interval)
468
parser.error("option --interval: Unparseable time")
470
cert = gnutls.crypto.X509Certificate(open(options.cert).read())
471
key = gnutls.crypto.X509PrivateKey(open(options.key).read())
472
ca = gnutls.crypto.X509Certificate(open(options.ca).read())
473
crl = gnutls.crypto.X509CRL(open(options.crl).read())
474
cred = gnutls.connection.X509Credentials(cert, key, [ca], [crl])
476
653
# Parse config file
654
defaults = { "timeout": "1h",
656
"checker": "fping -q -- %%(fqdn)s",
478
658
client_config = ConfigParser.SafeConfigParser(defaults)
479
#client_config.readfp(open("secrets.conf"), "secrets.conf")
659
#client_config.readfp(open("global.conf"), "global.conf")
480
660
client_config.read("mandos-clients.conf")
482
# From the Avahi server example code
663
serviceName = options.servicename;
668
# From the Avahi example code
483
669
DBusGMainLoop(set_as_default=True )
484
670
main_loop = gobject.MainLoop()
485
671
bus = dbus.SystemBus()
488
674
avahi.DBUS_INTERFACE_SERVER )
489
675
# End of Avahi example code
677
debug = options.debug
680
console = logging.StreamHandler()
681
# console.setLevel(logging.DEBUG)
682
console.setFormatter(logging.Formatter\
683
('%(levelname)s: %(message)s'))
684
logger.addHandler(console)
492
688
def remove_from_clients(client):
493
689
clients.remove(client)
495
print "No clients left, exiting"
691
logger.debug(u"No clients left, exiting")
498
clients.update(Set(Client(name=section, options=options,
694
clients.update(Set(Client(name=section,
499
695
stop_hook = remove_from_clients,
500
696
**(dict(client_config\
501
697
.items(section))))
502
698
for section in client_config.sections()))
704
"Cleanup function; run on exit"
706
# From the Avahi example code
707
if not group is None:
710
# End of Avahi example code
713
client = clients.pop()
714
client.stop_hook = None
717
atexit.register(cleanup)
720
signal.signal(signal.SIGINT, signal.SIG_IGN)
721
signal.signal(signal.SIGHUP, lambda signum, frame: killme())
722
signal.signal(signal.SIGTERM, lambda signum, frame: killme())
503
724
for client in clients:
506
tcp_server = IPv6_TCPServer((None, options.port),
727
tcp_server = IPv6_TCPServer((options.address, options.port),
511
731
# Find out what random port we got
512
733
servicePort = tcp_server.socket.getsockname()[1]
513
#sys.stderr.write("Now listening on port %d\n" % servicePort)
734
logger.debug(u"Now listening on port %d", servicePort)
515
736
if options.interface is not None:
737
global serviceInterface
516
738
serviceInterface = if_nametoindex(options.interface)
518
# From the Avahi server example code
740
# From the Avahi example code
519
741
server.connect_to_signal("StateChanged", server_state_changed)
520
server_state_changed(server.GetState())
743
server_state_changed(server.GetState())
744
except dbus.exceptions.DBusException, error:
745
logger.critical(u"DBusException: %s", error)
521
747
# End of Avahi example code
523
749
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,