2
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: "AvahiService.add", "AvahiService.remove",
10
# "server_state_changed", "entry_group_state_changed", and some lines
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
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 <mandos@fukt.bsnet.se>.
4
32
from __future__ import division
31
61
from dbus.mainloop.glib import DBusGMainLoop
35
import logging.handlers
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.
37
76
logger = logging.Logger('mandos')
38
77
syslogger = logging.handlers.SysLogHandler\
42
81
logger.addHandler(syslogger)
45
# This variable is used to optionally bind to a specified interface.
46
# It is a global variable to fit in with the other variables from the
47
# Avahi server example code.
48
serviceInterface = avahi.IF_UNSPEC
49
# From the Avahi server example code:
50
serviceName = "Mandos"
51
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
52
servicePort = None # Not known at startup
53
serviceTXT = [] # TXT record for the service
54
domain = "" # Domain to publish on, default to .local
55
host = "" # Host to publish records for, default to localhost
56
group = None #our entry group
57
rename_count = 12 # Counter so we only rename after collisions a
58
# sensible number of times
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
59
168
# End of Avahi example code
67
176
uniquely identify the client
68
177
secret: bytestring; sent verbatim (over TLS) to client
69
178
fqdn: string (FQDN); available for use by the checker command
70
created: datetime.datetime()
71
last_seen: datetime.datetime() or None if not yet seen
72
timeout: datetime.timedelta(); How long from last_seen until
73
this client is invalid
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
74
183
interval: datetime.timedelta(); How often to start a new checker
75
184
stop_hook: If set, called by stop() as stop_hook(self)
76
185
checker: subprocess.Popen(); a running checker process used
77
186
to see if the client lives.
78
Is None if no process is running.
187
'None' if no process is running.
79
188
checker_initiator_tag: a gobject event source tag, or None
80
189
stop_initiator_tag: - '' -
81
190
checker_callback_tag: - '' -
82
191
checker_command: string; External command which is run to check if
83
client lives. %()s expansions are done at
192
client lives. %() expansions are done at
84
193
runtime with vars(self) as dict, so that for
85
194
instance %(name)s can be used in the command.
86
195
Private attibutes:
87
196
_timeout: Real variable for 'timeout'
88
197
_interval: Real variable for 'interval'
89
_timeout_milliseconds: Used by gobject.timeout_add()
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
90
199
_interval_milliseconds: - '' -
92
201
def _set_timeout(self, timeout):
112
221
interval = property(lambda self: self._interval,
114
223
del _set_interval
115
def __init__(self, name=None, options=None, stop_hook=None,
116
fingerprint=None, secret=None, secfile=None,
117
fqdn=None, timeout=None, interval=-1, checker=None):
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.."""
230
logger.debug(u"Creating client %r", self.name)
119
231
# Uppercase and remove spaces from fingerprint
120
232
# for later comparison purposes with return value of
121
233
# the fingerprint() function
122
234
self.fingerprint = fingerprint.upper().replace(u" ", u"")
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
124
237
self.secret = secret.decode(u"base64")
163
270
"""Stop this client.
164
The possibility that this client might be restarted is left
165
open, but not currently used."""
166
logger.debug(u"Stopping client %s", self.name)
168
if self.stop_initiator_tag:
271
The possibility that a client might be restarted is left open,
272
but not currently used."""
273
# If this client doesn't have a secret, it is already stopped.
275
logger.debug(u"Stopping client %s", self.name)
279
if getattr(self, "stop_initiator_tag", False):
169
280
gobject.source_remove(self.stop_initiator_tag)
170
281
self.stop_initiator_tag = None
171
if self.checker_initiator_tag:
282
if getattr(self, "checker_initiator_tag", False):
172
283
gobject.source_remove(self.checker_initiator_tag)
173
284
self.checker_initiator_tag = None
174
285
self.stop_checker()
177
288
# Do not run this again if called by a gobject.timeout_add
179
290
def __del__(self):
180
# Some code duplication here and in stop()
181
if hasattr(self, "stop_initiator_tag") \
182
and self.stop_initiator_tag:
183
gobject.source_remove(self.stop_initiator_tag)
184
self.stop_initiator_tag = None
185
if hasattr(self, "checker_initiator_tag") \
186
and self.checker_initiator_tag:
187
gobject.source_remove(self.checker_initiator_tag)
188
self.checker_initiator_tag = None
291
self.stop_hook = None
190
293
def checker_callback(self, pid, condition):
191
294
"""The checker has completed, so take appropriate actions."""
192
295
now = datetime.datetime.now()
296
self.checker_callback_tag = None
193
298
if os.WIFEXITED(condition) \
194
299
and (os.WEXITSTATUS(condition) == 0):
195
300
logger.debug(u"Checker for %(name)s succeeded",
302
self.last_checked_ok = now
198
303
gobject.source_remove(self.stop_initiator_tag)
199
304
self.stop_initiator_tag = gobject.timeout_add\
200
305
(self._timeout_milliseconds,
206
311
logger.debug(u"Checker for %(name)s failed",
209
self.checker_callback_tag = None
210
313
def start_checker(self):
211
314
"""Start a new checker subprocess if one is not running.
212
315
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.
214
325
if self.checker is None:
327
# In case check_command has exactly one % operator
216
328
command = self.check_command % self.fqdn
217
329
except TypeError:
330
# Escape attributes for the shell
218
331
escaped_attrs = dict((key, re.escape(str(val)))
220
333
vars(self).iteritems())
222
335
command = self.check_command % escaped_attrs
223
336
except TypeError, error:
224
logger.critical(u'Could not format string "%s":'
225
u' %s', self.check_command, error)
337
logger.error(u'Could not format string "%s":'
338
u' %s', self.check_command, error)
226
339
return True # Try again later
228
341
logger.debug(u"Starting checker %r for %s",
229
342
command, self.name)
230
self.checker = subprocess.\
232
close_fds=True, shell=True,
343
self.checker = subprocess.Popen(command,
234
346
self.checker_callback_tag = gobject.child_watch_add\
235
347
(self.checker.pid,
236
348
self.checker_callback)
242
354
def stop_checker(self):
243
355
"""Force the checker process, if any, to stop."""
244
if not hasattr(self, "checker") or self.checker is None:
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:
246
gobject.source_remove(self.checker_callback_tag)
247
self.checker_callback_tag = None
248
os.kill(self.checker.pid, signal.SIGTERM)
249
if self.checker.poll() is None:
250
os.kill(self.checker.pid, signal.SIGKILL)
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
251
370
self.checker = None
252
def still_valid(self, now=None):
371
def still_valid(self):
253
372
"""Has the timeout not yet passed for this client?"""
255
now = datetime.datetime.now()
256
if self.last_seen is None:
373
now = datetime.datetime.now()
374
if self.last_checked_ok is None:
257
375
return now < (self.created + self.timeout)
259
return now < (self.last_seen + self.timeout)
377
return now < (self.last_checked_ok + self.timeout)
262
380
def peer_certificate(session):
263
"Return an OpenPGP data packet string for the peer's certificate"
381
"Return the peer's OpenPGP certificate as a bytestring"
264
382
# If not an OpenPGP certificate...
265
383
if gnutls.library.functions.gnutls_certificate_type_get\
266
384
(session._c_object) \
315
433
def handle(self):
316
434
logger.debug(u"TCP connection from: %s",
317
435
unicode(self.client_address))
318
session = gnutls.connection.ClientSession(self.request,
436
session = gnutls.connection.ClientSession\
437
(self.request, gnutls.connection.X509Credentials())
438
# Note: gnutls.connection.X509Credentials is really a generic
439
# GnuTLS certificate credentials object so long as no X.509
440
# keys are added to it. Therefore, we can use it here despite
441
# using OpenPGP certificates.
322
443
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
323
444
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
325
priority = "SECURE256"
446
priority = "NORMAL" # Fallback default, since this
448
if self.server.settings["priority"]:
449
priority = self.server.settings["priority"]
327
450
gnutls.library.functions.gnutls_priority_set_direct\
328
451
(session._c_object, priority, None);
387
509
"""This overrides the normal server_bind() function
388
510
to bind to an interface if one was specified, and also NOT to
389
511
bind to an address or port if they were not specified."""
390
if self.options.interface:
391
if not hasattr(socket, "SO_BINDTODEVICE"):
392
# From /usr/include/asm-i486/socket.h
393
socket.SO_BINDTODEVICE = 25
512
if self.settings["interface"]:
513
# 25 is from /usr/include/asm-i486/socket.h
514
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
395
516
self.socket.setsockopt(socket.SOL_SOCKET,
396
socket.SO_BINDTODEVICE,
397
self.options.interface)
518
self.settings["interface"])
398
519
except socket.error, error:
399
520
if error[0] == errno.EPERM:
400
521
logger.warning(u"No permission to"
401
522
u" bind to interface %s",
402
self.options.interface)
523
self.settings["interface"])
405
526
# Only bind(2) the socket if we really need to.
452
"""From the Avahi server example code"""
453
global group, serviceName, serviceType, servicePort, serviceTXT, \
456
group = dbus.Interface(
457
bus.get_object( avahi.DBUS_NAME,
458
server.EntryGroupNew()),
459
avahi.DBUS_INTERFACE_ENTRY_GROUP)
460
group.connect_to_signal('StateChanged',
461
entry_group_state_changed)
462
logger.debug(u"Adding service '%s' of type '%s' ...",
463
serviceName, serviceType)
466
serviceInterface, # interface
467
avahi.PROTO_INET6, # protocol
468
dbus.UInt32(0), # flags
469
serviceName, serviceType,
471
dbus.UInt16(servicePort),
472
avahi.string_array_to_txt_array(serviceTXT))
476
def remove_service():
477
"""From the Avahi server example code"""
480
if not group is None:
484
572
def server_state_changed(state):
485
"""From the Avahi server example code"""
573
"""Derived from the Avahi example code"""
486
574
if state == avahi.SERVER_COLLISION:
487
575
logger.warning(u"Server name collision")
489
577
elif state == avahi.SERVER_RUNNING:
493
581
def entry_group_state_changed(state, error):
494
"""From the Avahi server example code"""
495
global serviceName, server, rename_count
582
"""Derived from the Avahi example code"""
497
583
logger.debug(u"state change: %i", state)
499
585
if state == avahi.ENTRY_GROUP_ESTABLISHED:
500
586
logger.debug(u"Service established.")
501
587
elif state == avahi.ENTRY_GROUP_COLLISION:
503
rename_count = rename_count - 1
505
name = server.GetAlternativeServiceName(name)
506
logger.warning(u"Service name collision, "
507
u"changing name to '%s' ...", name)
512
logger.error(u"No suitable service name found after %i"
513
u" retries, exiting.", n_rename)
588
logger.warning(u"Service name collision.")
515
590
elif state == avahi.ENTRY_GROUP_FAILURE:
516
logger.error(u"Error in group state changed %s",
521
def if_nametoindex(interface):
522
"""Call the C function if_nametoindex()"""
591
logger.critical(u"Error in group state changed %s",
593
raise AvahiGroupError("State changed: %s", str(error))
595
def if_nametoindex(interface, _func=[None]):
596
"""Call the C function if_nametoindex(), or equivalent"""
597
if _func[0] is not None:
598
return _func[0](interface)
524
libc = ctypes.cdll.LoadLibrary("libc.so.6")
525
return libc.if_nametoindex(interface)
600
if "ctypes.util" not in sys.modules:
604
libc = ctypes.cdll.LoadLibrary\
605
(ctypes.util.find_library("c"))
606
_func[0] = libc.if_nametoindex
607
return _func[0](interface)
526
611
except (OSError, AttributeError):
527
612
if "struct" not in sys.modules:
529
614
if "fcntl" not in sys.modules:
531
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
533
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
534
struct.pack("16s16x", interface))
536
interface_index = struct.unpack("I", ifreq[16:20])[0]
537
return interface_index
616
def the_hard_way(interface):
617
"Get an interface index the hard way, i.e. using fcntl()"
618
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
620
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
621
struct.pack("16s16x", interface))
623
interface_index = struct.unpack("I", ifreq[16:20])[0]
624
return interface_index
625
_func[0] = the_hard_way
626
return _func[0](interface)
540
629
def daemon(nochdir, noclose):
561
def killme(status = 0):
562
logger.debug("Stopping server with exit status %d", status)
564
if main_loop_started:
570
if __name__ == '__main__':
651
global main_loop_started
572
652
main_loop_started = False
573
654
parser = OptionParser()
574
655
parser.add_option("-i", "--interface", type="string",
575
default=None, metavar="IF",
576
help="Bind to interface IF")
577
parser.add_option("-p", "--port", type="int", default=None,
656
metavar="IF", help="Bind to interface IF")
657
parser.add_option("-a", "--address", type="string",
658
help="Address to listen for requests on")
659
parser.add_option("-p", "--port", type="int",
578
660
help="Port number to receive requests on")
579
parser.add_option("--timeout", type="string", # Parsed later
581
help="Amount of downtime allowed for clients")
582
parser.add_option("--interval", type="string", # Parsed later
584
help="How often to check that a client is up")
585
661
parser.add_option("--check", action="store_true", default=False,
586
662
help="Run self-test")
587
663
parser.add_option("--debug", action="store_true", default=False,
664
help="Debug mode; run in foreground and log to"
666
parser.add_option("--priority", type="string", help="GnuTLS"
667
" priority string (see GnuTLS documentation)")
668
parser.add_option("--servicename", type="string", metavar="NAME",
669
help="Zeroconf service name")
670
parser.add_option("--configdir", type="string",
671
default="/etc/mandos", metavar="DIR",
672
help="Directory to search for configuration"
589
674
(options, args) = parser.parse_args()
591
676
if options.check:
593
678
doctest.testmod()
596
# Parse the time arguments
598
options.timeout = string_to_delta(options.timeout)
600
parser.error("option --timeout: Unparseable time")
602
options.interval = string_to_delta(options.interval)
604
parser.error("option --interval: Unparseable time")
607
defaults = { "checker": "fping -q -- %%(fqdn)s" }
608
client_config = ConfigParser.SafeConfigParser(defaults)
609
#client_config.readfp(open("secrets.conf"), "secrets.conf")
610
client_config.read("mandos-clients.conf")
612
# From the Avahi server example code
681
# Default values for config file for server-global settings
682
server_defaults = { "interface": "",
687
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
688
"servicename": "Mandos",
691
# Parse config file for server-global settings
692
server_config = ConfigParser.SafeConfigParser(server_defaults)
694
server_config.read(os.path.join(options.configdir, "server.conf"))
695
server_section = "server"
696
# Convert the SafeConfigParser object to a dict
697
server_settings = dict(server_config.items(server_section))
698
# Use getboolean on the boolean config option
699
server_settings["debug"] = server_config.getboolean\
700
(server_section, "debug")
703
# Override the settings from the config file with command line
705
for option in ("interface", "address", "port", "debug",
706
"priority", "servicename", "configdir"):
707
value = getattr(options, option)
708
if value is not None:
709
server_settings[option] = value
711
# Now we have our good server settings in "server_settings"
713
# Parse config file with clients
714
client_defaults = { "timeout": "1h",
716
"checker": "fping -q -- %%(fqdn)s",
718
client_config = ConfigParser.SafeConfigParser(client_defaults)
719
client_config.read(os.path.join(server_settings["configdir"],
723
service = AvahiService(name = server_settings["servicename"],
724
type = "_mandos._tcp", );
725
if server_settings["interface"]:
726
service.interface = if_nametoindex(server_settings["interface"])
731
# From the Avahi example code
613
732
DBusGMainLoop(set_as_default=True )
614
733
main_loop = gobject.MainLoop()
615
734
bus = dbus.SystemBus()
663
783
signal.signal(signal.SIGINT, signal.SIG_IGN)
664
signal.signal(signal.SIGHUP, lambda signum, frame: killme())
665
signal.signal(signal.SIGTERM, lambda signum, frame: killme())
784
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
785
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
667
787
for client in clients:
670
tcp_server = IPv6_TCPServer((None, options.port),
790
tcp_server = IPv6_TCPServer((server_settings["address"],
791
server_settings["port"]),
793
settings=server_settings,
674
# Find out what random port we got
675
servicePort = tcp_server.socket.getsockname()[1]
676
logger.debug(u"Now listening on port %d", servicePort)
678
if options.interface is not None:
679
serviceInterface = if_nametoindex(options.interface)
681
# From the Avahi server example code
682
server.connect_to_signal("StateChanged", server_state_changed)
684
server_state_changed(server.GetState())
685
except dbus.exceptions.DBusException, error:
686
logger.critical(u"DBusException: %s", error)
688
# End of Avahi example code
690
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
691
lambda *args, **kwargs:
692
tcp_server.handle_request(*args[2:],
795
# Find out what port we got
796
service.port = tcp_server.socket.getsockname()[1]
797
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
798
u" scope_id %d" % tcp_server.socket.getsockname())
800
#service.interface = tcp_server.socket.getsockname()[3]
803
# From the Avahi example code
804
server.connect_to_signal("StateChanged", server_state_changed)
806
server_state_changed(server.GetState())
807
except dbus.exceptions.DBusException, error:
808
logger.critical(u"DBusException: %s", error)
810
# End of Avahi example code
812
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
813
lambda *args, **kwargs:
814
tcp_server.handle_request\
815
(*args[2:], **kwargs) or True)
817
logger.debug("Starting main loop")
695
818
main_loop_started = True
820
except AvahiError, error:
821
logger.critical(u"AvahiError: %s" + unicode(error))
697
823
except KeyboardInterrupt:
827
if __name__ == '__main__':