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
# following functions: "AvahiService.add", "AvahiService.remove",
9
# following functions: "add_service", "remove_service",
10
10
# "server_state_changed", "entry_group_state_changed", and some lines
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
13
# Everything else is Copyright © 2007-2008 Teddy Hogeborn and Björn
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
81
82
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.error(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))
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
88
serviceInterface = avahi.IF_UNSPEC
166
89
# From the Avahi example code:
167
group = None # our entry group
90
serviceName = "Mandos"
91
serviceType = "_mandos._tcp" # http://www.dns-sd.org/ServiceTypes.html
92
servicePort = None # Not known at startup
93
serviceTXT = [] # TXT record for the service
94
domain = "" # Domain to publish on, default to .local
95
host = "" # Host to publish records for, default to localhost
96
group = None #our entry group
97
rename_count = 12 # Counter so we only rename after collisions a
98
# sensible number of times
168
99
# End of Avahi example code
176
107
uniquely identify the client
177
108
secret: bytestring; sent verbatim (over TLS) to client
178
109
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
110
created: datetime.datetime()
111
last_seen: datetime.datetime() or None if not yet seen
112
timeout: datetime.timedelta(); How long from last_seen until
113
this client is invalid
183
114
interval: datetime.timedelta(); How often to start a new checker
184
115
stop_hook: If set, called by stop() as stop_hook(self)
185
116
checker: subprocess.Popen(); a running checker process used
186
117
to see if the client lives.
187
'None' if no process is running.
118
Is None if no process is running.
188
119
checker_initiator_tag: a gobject event source tag, or None
189
120
stop_initiator_tag: - '' -
190
121
checker_callback_tag: - '' -
191
122
checker_command: string; External command which is run to check if
192
client lives. %() expansions are done at
123
client lives. %()s expansions are done at
193
124
runtime with vars(self) as dict, so that for
194
125
instance %(name)s can be used in the command.
195
126
Private attibutes:
196
127
_timeout: Real variable for 'timeout'
197
128
_interval: Real variable for 'interval'
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
129
_timeout_milliseconds: Used by gobject.timeout_add()
199
130
_interval_milliseconds: - '' -
201
132
def _set_timeout(self, timeout):
221
152
interval = property(lambda self: self._interval,
223
154
del _set_interval
224
def __init__(self, name = None, stop_hook=None, config={}):
155
def __init__(self, name=None, options=None, stop_hook=None,
156
fingerprint=None, secret=None, secfile=None,
157
fqdn=None, timeout=None, interval=-1, checker=None):
225
158
"""Note: the 'checker' argument sets the 'checker_command'
226
159
attribute and not the 'checker' attribute.."""
228
logger.debug(u"Creating client %r", self.name)
229
161
# Uppercase and remove spaces from fingerprint
230
162
# for later comparison purposes with return value of
231
163
# the fingerprint() function
232
self.fingerprint = config["fingerprint"].upper()\
234
logger.debug(u" Fingerprint: %s", self.fingerprint)
235
if "secret" in config:
236
self.secret = config["secret"].decode(u"base64")
237
elif "secfile" in config:
238
sf = open(config["secfile"])
164
self.fingerprint = fingerprint.upper().replace(u" ", u"")
166
self.secret = secret.decode(u"base64")
239
169
self.secret = sf.read()
242
raise TypeError(u"No secret or secfile for client %s"
244
self.fqdn = config.get("fqdn", "")
172
raise RuntimeError(u"No secret or secfile for client %s"
174
self.fqdn = fqdn # string
245
175
self.created = datetime.datetime.now()
246
self.last_checked_ok = None
247
self.timeout = string_to_delta(config["timeout"])
248
self.interval = string_to_delta(config["interval"])
176
self.last_seen = None
178
self.timeout = options.timeout
180
self.timeout = string_to_delta(timeout)
182
self.interval = options.interval
184
self.interval = string_to_delta(interval)
249
185
self.stop_hook = stop_hook
250
186
self.checker = None
251
187
self.checker_initiator_tag = None
252
188
self.stop_initiator_tag = None
253
189
self.checker_callback_tag = None
254
self.check_command = config["checker"]
190
self.check_command = checker
256
192
"""Start this client's checker and timeout hooks"""
257
193
# Schedule a new checker to be started an 'interval' from now,
269
205
"""Stop this client.
270
The possibility that a client might be restarted is left open,
271
but not currently used."""
206
The possibility that this client might be restarted is left
207
open, but not currently used."""
272
208
# If this client doesn't have a secret, it is already stopped.
274
logger.info(u"Stopping client %s", self.name)
210
logger.debug(u"Stopping client %s", self.name)
275
211
self.secret = None
278
if getattr(self, "stop_initiator_tag", False):
214
if hasattr(self, "stop_initiator_tag") \
215
and self.stop_initiator_tag:
279
216
gobject.source_remove(self.stop_initiator_tag)
280
217
self.stop_initiator_tag = None
281
if getattr(self, "checker_initiator_tag", False):
218
if hasattr(self, "checker_initiator_tag") \
219
and self.checker_initiator_tag:
282
220
gobject.source_remove(self.checker_initiator_tag)
283
221
self.checker_initiator_tag = None
284
222
self.stop_checker()
323
261
# is as it should be.
324
262
if self.checker is None:
326
# In case check_command has exactly one % operator
327
264
command = self.check_command % self.fqdn
328
265
except TypeError:
329
# Escape attributes for the shell
330
266
escaped_attrs = dict((key, re.escape(str(val)))
332
268
vars(self).iteritems())
334
270
command = self.check_command % escaped_attrs
335
271
except TypeError, error:
336
logger.error(u'Could not format string "%s":'
337
u' %s', self.check_command, error)
272
logger.critical(u'Could not format string "%s":'
273
u' %s', self.check_command, error)
338
274
return True # Try again later
340
logger.info(u"Starting checker %r for %s",
342
self.checker = subprocess.Popen(command,
276
logger.debug(u"Starting checker %r for %s",
278
self.checker = subprocess.\
280
close_fds=True, shell=True,
345
282
self.checker_callback_tag = gobject.child_watch_add\
346
283
(self.checker.pid,
347
284
self.checker_callback)
364
301
#if self.checker.poll() is None:
365
302
# os.kill(self.checker.pid, signal.SIGKILL)
366
303
except OSError, error:
367
if error.errno != errno.ESRCH: # No such process
304
if error.errno != errno.ESRCH:
369
306
self.checker = None
370
def still_valid(self):
307
def still_valid(self, now=None):
371
308
"""Has the timeout not yet passed for this client?"""
372
now = datetime.datetime.now()
373
if self.last_checked_ok is None:
310
now = datetime.datetime.now()
311
if self.last_seen is None:
374
312
return now < (self.created + self.timeout)
376
return now < (self.last_checked_ok + self.timeout)
314
return now < (self.last_seen + self.timeout)
379
317
def peer_certificate(session):
430
368
Note: This will run in its own forked process."""
432
370
def handle(self):
433
logger.info(u"TCP connection from: %s",
371
logger.debug(u"TCP connection from: %s",
434
372
unicode(self.client_address))
435
session = gnutls.connection.ClientSession\
436
(self.request, gnutls.connection.X509Credentials())
438
line = self.request.makefile().readline()
439
logger.debug(u"Protocol version: %r", line)
441
if int(line.strip().split()[0]) > 1:
443
except (ValueError, IndexError, RuntimeError), error:
444
logger.error(u"Unknown protocol version: %s", error)
447
# Note: gnutls.connection.X509Credentials is really a generic
448
# GnuTLS certificate credentials object so long as no X.509
449
# keys are added to it. Therefore, we can use it here despite
450
# using OpenPGP certificates.
373
session = gnutls.connection.ClientSession(self.request,
452
377
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
453
378
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
455
priority = "NORMAL" # Fallback default, since this
457
if self.server.settings["priority"]:
458
priority = self.server.settings["priority"]
380
priority = "SECURE256"
459
382
gnutls.library.functions.gnutls_priority_set_direct\
460
383
(session._c_object, priority, None);
463
386
session.handshake()
464
387
except gnutls.errors.GNUTLSError, error:
465
logger.warning(u"Handshake failed: %s", error)
388
logger.debug(u"Handshake failed: %s", error)
466
389
# Do not run session.bye() here: the session is not
467
390
# established. Just abandon the request.
470
393
fpr = fingerprint(peer_certificate(session))
471
394
except (TypeError, gnutls.errors.GNUTLSError), error:
472
logger.warning(u"Bad certificate: %s", error)
395
logger.debug(u"Bad certificate: %s", error)
475
398
logger.debug(u"Fingerprint: %s", fpr)
520
442
"""This overrides the normal server_bind() function
521
443
to bind to an interface if one was specified, and also NOT to
522
444
bind to an address or port if they were not specified."""
523
if self.settings["interface"]:
524
# 25 is from /usr/include/asm-i486/socket.h
525
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
445
if self.options.interface:
446
if not hasattr(socket, "SO_BINDTODEVICE"):
447
# From /usr/include/asm-i486/socket.h
448
socket.SO_BINDTODEVICE = 25
527
450
self.socket.setsockopt(socket.SOL_SOCKET,
529
self.settings["interface"])
451
socket.SO_BINDTODEVICE,
452
self.options.interface)
530
453
except socket.error, error:
531
454
if error[0] == errno.EPERM:
532
logger.error(u"No permission to"
533
u" bind to interface %s",
534
self.settings["interface"])
455
logger.warning(u"No permission to"
456
u" bind to interface %s",
457
self.options.interface)
537
460
# Only bind(2) the socket if we really need to.
507
"""Derived from the Avahi example code"""
508
global group, serviceName, serviceType, servicePort, serviceTXT, \
511
group = dbus.Interface(
512
bus.get_object( avahi.DBUS_NAME,
513
server.EntryGroupNew()),
514
avahi.DBUS_INTERFACE_ENTRY_GROUP)
515
group.connect_to_signal('StateChanged',
516
entry_group_state_changed)
517
logger.debug(u"Adding service '%s' of type '%s' ...",
518
serviceName, serviceType)
521
serviceInterface, # interface
522
avahi.PROTO_INET6, # protocol
523
dbus.UInt32(0), # flags
524
serviceName, serviceType,
526
dbus.UInt16(servicePort),
527
avahi.string_array_to_txt_array(serviceTXT))
531
def remove_service():
532
"""From the Avahi example code"""
535
if not group is None:
583
539
def server_state_changed(state):
584
540
"""Derived from the Avahi example code"""
585
541
if state == avahi.SERVER_COLLISION:
586
logger.error(u"Server name collision")
542
logger.warning(u"Server name collision")
588
544
elif state == avahi.SERVER_RUNNING:
592
548
def entry_group_state_changed(state, error):
593
549
"""Derived from the Avahi example code"""
550
global serviceName, server, rename_count
594
552
logger.debug(u"state change: %i", state)
596
554
if state == avahi.ENTRY_GROUP_ESTABLISHED:
597
555
logger.debug(u"Service established.")
598
556
elif state == avahi.ENTRY_GROUP_COLLISION:
599
logger.warning(u"Service name collision.")
558
rename_count = rename_count - 1
560
name = server.GetAlternativeServiceName(name)
561
logger.warning(u"Service name collision, "
562
u"changing name to '%s' ...", name)
567
logger.error(u"No suitable service name found after %i"
568
u" retries, exiting.", n_rename)
601
570
elif state == avahi.ENTRY_GROUP_FAILURE:
602
logger.critical(u"Error in group state changed %s",
604
raise AvahiGroupError("State changed: %s", str(error))
571
logger.error(u"Error in group state changed %s",
606
576
def if_nametoindex(interface):
607
"""Call the C function if_nametoindex(), or equivalent"""
608
global if_nametoindex
577
"""Call the C function if_nametoindex()"""
610
if "ctypes.util" not in sys.modules:
612
if_nametoindex = ctypes.cdll.LoadLibrary\
613
(ctypes.util.find_library("c")).if_nametoindex
579
libc = ctypes.cdll.LoadLibrary("libc.so.6")
580
return libc.if_nametoindex(interface)
614
581
except (OSError, AttributeError):
615
582
if "struct" not in sys.modules:
617
584
if "fcntl" not in sys.modules:
619
def if_nametoindex(interface):
620
"Get an interface index the hard way, i.e. using fcntl()"
621
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
623
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
624
struct.pack("16s16x", interface))
626
interface_index = struct.unpack("I", ifreq[16:20])[0]
627
return interface_index
628
return if_nametoindex(interface)
586
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
588
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
589
struct.pack("16s16x", interface))
591
interface_index = struct.unpack("I", ifreq[16:20])[0]
592
return interface_index
631
595
def daemon(nochdir, noclose):
616
def killme(status = 0):
617
logger.debug("Stopping server with exit status %d", status)
619
if main_loop_started:
653
628
global main_loop_started
654
629
main_loop_started = False
656
631
parser = OptionParser()
657
632
parser.add_option("-i", "--interface", type="string",
658
metavar="IF", help="Bind to interface IF")
659
parser.add_option("-a", "--address", type="string",
633
default=None, metavar="IF",
634
help="Bind to interface IF")
635
parser.add_option("-a", "--address", type="string", default=None,
660
636
help="Address to listen for requests on")
661
parser.add_option("-p", "--port", type="int",
637
parser.add_option("-p", "--port", type="int", default=None,
662
638
help="Port number to receive requests on")
639
parser.add_option("--timeout", type="string", # Parsed later
641
help="Amount of downtime allowed for clients")
642
parser.add_option("--interval", type="string", # Parsed later
644
help="How often to check that a client is up")
663
645
parser.add_option("--check", action="store_true", default=False,
664
646
help="Run self-test")
665
647
parser.add_option("--debug", action="store_true", default=False,
666
help="Debug mode; run in foreground and log to"
668
parser.add_option("--priority", type="string", help="GnuTLS"
669
" priority string (see GnuTLS documentation)")
670
parser.add_option("--servicename", type="string", metavar="NAME",
671
help="Zeroconf service name")
672
parser.add_option("--configdir", type="string",
673
default="/etc/mandos", metavar="DIR",
674
help="Directory to search for configuration"
676
649
(options, args) = parser.parse_args()
678
651
if options.check:
680
653
doctest.testmod()
683
# Default values for config file for server-global settings
684
server_defaults = { "interface": "",
689
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
690
"servicename": "Mandos",
693
# Parse config file for server-global settings
694
server_config = ConfigParser.SafeConfigParser(server_defaults)
696
server_config.read(os.path.join(options.configdir, "server.conf"))
697
server_section = "server"
698
# Convert the SafeConfigParser object to a dict
699
server_settings = dict(server_config.items(server_section))
700
# Use getboolean on the boolean config option
701
server_settings["debug"] = server_config.getboolean\
702
(server_section, "debug")
705
# Override the settings from the config file with command line
707
for option in ("interface", "address", "port", "debug",
708
"priority", "servicename", "configdir"):
709
value = getattr(options, option)
710
if value is not None:
711
server_settings[option] = value
713
# Now we have our good server settings in "server_settings"
715
# Parse config file with clients
716
client_defaults = { "timeout": "1h",
718
"checker": "fping -q -- %%(fqdn)s",
720
client_config = ConfigParser.SafeConfigParser(client_defaults)
721
client_config.read(os.path.join(server_settings["configdir"],
725
service = AvahiService(name = server_settings["servicename"],
726
type = "_mandos._tcp", );
727
if server_settings["interface"]:
728
service.interface = if_nametoindex(server_settings["interface"])
656
# Parse the time arguments
658
options.timeout = string_to_delta(options.timeout)
660
parser.error("option --timeout: Unparseable time")
662
options.interval = string_to_delta(options.interval)
664
parser.error("option --interval: Unparseable time")
667
defaults = { "checker": "fping -q -- %%(fqdn)s" }
668
client_config = ConfigParser.SafeConfigParser(defaults)
669
#client_config.readfp(open("global.conf"), "global.conf")
670
client_config.read("mandos-clients.conf")
785
727
signal.signal(signal.SIGINT, signal.SIG_IGN)
786
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
787
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
728
signal.signal(signal.SIGHUP, lambda signum, frame: killme())
729
signal.signal(signal.SIGTERM, lambda signum, frame: killme())
789
731
for client in clients:
792
tcp_server = IPv6_TCPServer((server_settings["address"],
793
server_settings["port"]),
734
tcp_server = IPv6_TCPServer((options.address, options.port),
795
settings=server_settings,
797
# Find out what port we got
798
service.port = tcp_server.socket.getsockname()[1]
799
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
800
u" scope_id %d" % tcp_server.socket.getsockname())
802
#service.interface = tcp_server.socket.getsockname()[3]
805
# From the Avahi example code
806
server.connect_to_signal("StateChanged", server_state_changed)
808
server_state_changed(server.GetState())
809
except dbus.exceptions.DBusException, error:
810
logger.critical(u"DBusException: %s", error)
812
# End of Avahi example code
814
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
815
lambda *args, **kwargs:
816
tcp_server.handle_request\
817
(*args[2:], **kwargs) or True)
738
# Find out what random port we got
740
servicePort = tcp_server.socket.getsockname()[1]
741
logger.debug(u"Now listening on port %d", servicePort)
743
if options.interface is not None:
744
global serviceInterface
745
serviceInterface = if_nametoindex(options.interface)
747
# From the Avahi example code
748
server.connect_to_signal("StateChanged", server_state_changed)
750
server_state_changed(server.GetState())
751
except dbus.exceptions.DBusException, error:
752
logger.critical(u"DBusException: %s", error)
754
# End of Avahi example code
756
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
757
lambda *args, **kwargs:
758
tcp_server.handle_request(*args[2:],
819
761
logger.debug("Starting main loop")
820
762
main_loop_started = True
822
except AvahiError, error:
823
logger.critical(u"AvahiError: %s" + unicode(error))
825
764
except KeyboardInterrupt:
829
770
if __name__ == '__main__':