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):
99
"""An Avahi (Zeroconf) service.
101
interface: integer; avahi.IF_UNSPEC or an interface index.
102
Used to optionally bind to the specified interface.
103
name: string; Example: 'Mandos'
104
type: string; Example: '_mandos._tcp'.
105
See <http://www.dns-sd.org/ServiceTypes.html>
106
port: integer; what port to announce
107
TXT: list of strings; TXT record for the service
108
domain: string; Domain to publish on, default to .local if empty.
109
host: string; Host to publish records for, default is 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
self.interface = interface
127
self.rename_count = 0
129
"""Derived from the Avahi example code"""
130
if self.rename_count >= self.max_renames:
131
logger.critical(u"No suitable service name found after %i"
132
u" retries, exiting.", rename_count)
133
raise AvahiServiceError("Too many renames")
134
name = server.GetAlternativeServiceName(name)
135
logger.error(u"Changing name to %r ...", name)
138
self.rename_count += 1
140
"""Derived from the Avahi example code"""
141
if group is not None:
144
"""Derived from the Avahi example code"""
147
group = dbus.Interface\
148
(bus.get_object(avahi.DBUS_NAME,
149
server.EntryGroupNew()),
150
avahi.DBUS_INTERFACE_ENTRY_GROUP)
151
group.connect_to_signal('StateChanged',
152
entry_group_state_changed)
153
logger.debug(u"Adding service '%s' of type '%s' ...",
154
service.name, service.type)
156
self.interface, # interface
157
avahi.PROTO_INET6, # protocol
158
dbus.UInt32(0), # flags
159
self.name, self.type,
160
self.domain, self.host,
161
dbus.UInt16(self.port),
162
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
165
89
# From the Avahi example code:
166
group = None # our entry group
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
167
99
# End of Avahi example code
175
107
uniquely identify the client
176
108
secret: bytestring; sent verbatim (over TLS) to client
177
109
fqdn: string (FQDN); available for use by the checker command
178
created: datetime.datetime(); object creation, not client host
179
last_checked_ok: datetime.datetime() or None if not yet checked OK
180
timeout: datetime.timedelta(); How long from last_checked_ok
181
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
182
114
interval: datetime.timedelta(); How often to start a new checker
183
115
stop_hook: If set, called by stop() as stop_hook(self)
184
116
checker: subprocess.Popen(); a running checker process used
185
117
to see if the client lives.
186
'None' if no process is running.
118
Is None if no process is running.
187
119
checker_initiator_tag: a gobject event source tag, or None
188
120
stop_initiator_tag: - '' -
189
121
checker_callback_tag: - '' -
190
122
checker_command: string; External command which is run to check if
191
client lives. %() expansions are done at
123
client lives. %()s expansions are done at
192
124
runtime with vars(self) as dict, so that for
193
125
instance %(name)s can be used in the command.
194
126
Private attibutes:
195
127
_timeout: Real variable for 'timeout'
196
128
_interval: Real variable for 'interval'
197
_timeout_milliseconds: Used when calling gobject.timeout_add()
129
_timeout_milliseconds: Used by gobject.timeout_add()
198
130
_interval_milliseconds: - '' -
200
132
def _set_timeout(self, timeout):
220
152
interval = property(lambda self: self._interval,
222
154
del _set_interval
223
def __init__(self, name = None, stop_hook=None, config={}):
224
"""Note: the 'checker' key in 'config' sets the
225
'checker_command' attribute and *not* the 'checker'
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.."""
228
161
logger.debug(u"Creating client %r", self.name)
229
# Uppercase and remove spaces from fingerprint for later
230
# comparison purposes with return value from the fingerprint()
232
self.fingerprint = config["fingerprint"].upper()\
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"")
234
166
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"])
168
self.secret = secret.decode(u"base64")
239
171
self.secret = sf.read()
242
raise TypeError(u"No secret or secfile for client %s"
244
self.fqdn = config.get("fqdn", "")
174
raise RuntimeError(u"No secret or secfile for client %s"
176
self.fqdn = fqdn # string
245
177
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"])
178
self.last_seen = None
179
self.timeout = string_to_delta(timeout)
180
self.interval = string_to_delta(interval)
249
181
self.stop_hook = stop_hook
250
182
self.checker = None
251
183
self.checker_initiator_tag = None
252
184
self.stop_initiator_tag = None
253
185
self.checker_callback_tag = None
254
self.check_command = config["checker"]
186
self.check_command = checker
256
188
"""Start this client's checker and timeout hooks"""
257
189
# Schedule a new checker to be started an 'interval' from now,
269
201
"""Stop this client.
270
The possibility that a client might be restarted is left open,
271
but not currently used."""
202
The possibility that this client might be restarted is left
203
open, but not currently used."""
272
204
# If this client doesn't have a secret, it is already stopped.
274
logger.info(u"Stopping client %s", self.name)
206
logger.debug(u"Stopping client %s", self.name)
275
207
self.secret = None
278
if getattr(self, "stop_initiator_tag", False):
210
if hasattr(self, "stop_initiator_tag") \
211
and self.stop_initiator_tag:
279
212
gobject.source_remove(self.stop_initiator_tag)
280
213
self.stop_initiator_tag = None
281
if getattr(self, "checker_initiator_tag", False):
214
if hasattr(self, "checker_initiator_tag") \
215
and self.checker_initiator_tag:
282
216
gobject.source_remove(self.checker_initiator_tag)
283
217
self.checker_initiator_tag = None
284
218
self.stop_checker()
323
257
# is as it should be.
324
258
if self.checker is None:
326
# In case check_command has exactly one % operator
327
260
command = self.check_command % self.fqdn
328
261
except TypeError:
329
# Escape attributes for the shell
330
262
escaped_attrs = dict((key, re.escape(str(val)))
332
264
vars(self).iteritems())
334
266
command = self.check_command % escaped_attrs
335
267
except TypeError, error:
336
logger.error(u'Could not format string "%s":'
337
u' %s', self.check_command, error)
268
logger.critical(u'Could not format string "%s":'
269
u' %s', self.check_command, error)
338
270
return True # Try again later
340
logger.info(u"Starting checker %r for %s",
342
self.checker = subprocess.Popen(command,
272
logger.debug(u"Starting checker %r for %s",
274
self.checker = subprocess.\
276
close_fds=True, shell=True,
345
278
self.checker_callback_tag = gobject.child_watch_add\
346
279
(self.checker.pid,
347
280
self.checker_callback)
364
297
#if self.checker.poll() is None:
365
298
# os.kill(self.checker.pid, signal.SIGKILL)
366
299
except OSError, error:
367
if error.errno != errno.ESRCH: # No such process
300
if error.errno != errno.ESRCH:
369
302
self.checker = None
370
def still_valid(self):
303
def still_valid(self, now=None):
371
304
"""Has the timeout not yet passed for this client?"""
372
now = datetime.datetime.now()
373
if self.last_checked_ok is None:
306
now = datetime.datetime.now()
307
if self.last_seen is None:
374
308
return now < (self.created + self.timeout)
376
return now < (self.last_checked_ok + self.timeout)
310
return now < (self.last_seen + self.timeout)
379
313
def peer_certificate(session):
396
330
def fingerprint(openpgp):
397
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\
398
336
# New GnuTLS "datum" with the OpenPGP public key
399
337
datum = gnutls.library.types.gnutls_datum_t\
400
338
(ctypes.cast(ctypes.c_char_p(openpgp),
401
339
ctypes.POINTER(ctypes.c_ubyte)),
402
340
ctypes.c_uint(len(openpgp)))
403
# New empty GnuTLS certificate
404
crt = gnutls.library.types.gnutls_openpgp_crt_t()
405
gnutls.library.functions.gnutls_openpgp_crt_init\
407
341
# Import the OpenPGP public key into the certificate
408
gnutls.library.functions.gnutls_openpgp_crt_import\
409
(crt, ctypes.byref(datum),
410
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
342
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
345
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
411
346
# New buffer for the fingerprint
412
347
buffer = ctypes.create_string_buffer(20)
413
348
buffer_length = ctypes.c_size_t()
429
364
Note: This will run in its own forked process."""
431
366
def handle(self):
432
logger.info(u"TCP connection from: %s",
367
logger.debug(u"TCP connection from: %s",
433
368
unicode(self.client_address))
434
session = gnutls.connection.ClientSession\
435
(self.request, gnutls.connection.X509Credentials())
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
# Note: gnutls.connection.X509Credentials is really a generic
447
# GnuTLS certificate credentials object so long as no X.509
448
# keys are added to it. Therefore, we can use it here despite
449
# using OpenPGP certificates.
369
session = gnutls.connection.ClientSession(self.request,
451
373
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
452
374
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
454
priority = "NORMAL" # Fallback default, since this
456
if self.server.settings["priority"]:
457
priority = self.server.settings["priority"]
377
if self.server.options.priority:
378
priority = self.server.options.priority
458
379
gnutls.library.functions.gnutls_priority_set_direct\
459
380
(session._c_object, priority, None);
462
383
session.handshake()
463
384
except gnutls.errors.GNUTLSError, error:
464
logger.warning(u"Handshake failed: %s", error)
385
logger.debug(u"Handshake failed: %s", error)
465
386
# Do not run session.bye() here: the session is not
466
387
# established. Just abandon the request.
469
390
fpr = fingerprint(peer_certificate(session))
470
391
except (TypeError, gnutls.errors.GNUTLSError), error:
471
logger.warning(u"Bad certificate: %s", error)
392
logger.debug(u"Bad certificate: %s", error)
474
395
logger.debug(u"Fingerprint: %s", fpr)
519
439
"""This overrides the normal server_bind() function
520
440
to bind to an interface if one was specified, and also NOT to
521
441
bind to an address or port if they were not specified."""
522
if self.settings["interface"]:
523
# 25 is from /usr/include/asm-i486/socket.h
524
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
442
if self.options.interface:
443
if not hasattr(socket, "SO_BINDTODEVICE"):
444
# From /usr/include/asm-i486/socket.h
445
socket.SO_BINDTODEVICE = 25
526
447
self.socket.setsockopt(socket.SOL_SOCKET,
528
self.settings["interface"])
448
socket.SO_BINDTODEVICE,
449
self.options.interface)
529
450
except socket.error, error:
530
451
if error[0] == errno.EPERM:
531
logger.error(u"No permission to"
532
u" bind to interface %s",
533
self.settings["interface"])
452
logger.warning(u"No permission to"
453
u" bind to interface %s",
454
self.options.interface)
536
457
# Only bind(2) the socket if we really need to.
504
"""Derived from the Avahi example code"""
505
global group, serviceName, serviceType, servicePort, serviceTXT, \
508
group = dbus.Interface(
509
bus.get_object( avahi.DBUS_NAME,
510
server.EntryGroupNew()),
511
avahi.DBUS_INTERFACE_ENTRY_GROUP)
512
group.connect_to_signal('StateChanged',
513
entry_group_state_changed)
514
logger.debug(u"Adding service '%s' of type '%s' ...",
515
serviceName, serviceType)
518
serviceInterface, # interface
519
avahi.PROTO_INET6, # protocol
520
dbus.UInt32(0), # flags
521
serviceName, serviceType,
523
dbus.UInt16(servicePort),
524
avahi.string_array_to_txt_array(serviceTXT))
528
def remove_service():
529
"""From the Avahi example code"""
532
if not group is None:
582
536
def server_state_changed(state):
583
537
"""Derived from the Avahi example code"""
584
538
if state == avahi.SERVER_COLLISION:
585
logger.error(u"Server name collision")
539
logger.warning(u"Server name collision")
587
541
elif state == avahi.SERVER_RUNNING:
591
545
def entry_group_state_changed(state, error):
592
546
"""Derived from the Avahi example code"""
547
global serviceName, server, rename_count
593
549
logger.debug(u"state change: %i", state)
595
551
if state == avahi.ENTRY_GROUP_ESTABLISHED:
596
552
logger.debug(u"Service established.")
597
553
elif state == avahi.ENTRY_GROUP_COLLISION:
598
logger.warning(u"Service name collision.")
555
rename_count = rename_count - 1
557
name = server.GetAlternativeServiceName(name)
558
logger.warning(u"Service name collision, "
559
u"changing name to '%s' ...", name)
564
logger.error(u"No suitable service name found after %i"
565
u" retries, exiting.", n_rename)
600
567
elif state == avahi.ENTRY_GROUP_FAILURE:
601
logger.critical(u"Error in group state changed %s",
603
raise AvahiGroupError("State changed: %s", str(error))
568
logger.error(u"Error in group state changed %s",
605
573
def if_nametoindex(interface):
606
"""Call the C function if_nametoindex(), or equivalent"""
607
global if_nametoindex
574
"""Call the C function if_nametoindex()"""
609
if "ctypes.util" not in sys.modules:
611
if_nametoindex = ctypes.cdll.LoadLibrary\
612
(ctypes.util.find_library("c")).if_nametoindex
576
libc = ctypes.cdll.LoadLibrary("libc.so.6")
577
return libc.if_nametoindex(interface)
613
578
except (OSError, AttributeError):
614
579
if "struct" not in sys.modules:
616
581
if "fcntl" not in sys.modules:
618
def if_nametoindex(interface):
619
"Get an interface index the hard way, i.e. using fcntl()"
620
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
622
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
623
struct.pack("16s16x", interface))
625
interface_index = struct.unpack("I", ifreq[16:20])[0]
626
return interface_index
627
return if_nametoindex(interface)
583
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
585
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
586
struct.pack("16s16x", interface))
588
interface_index = struct.unpack("I", ifreq[16:20])[0]
589
return interface_index
630
592
def daemon(nochdir, noclose):
613
def killme(status = 0):
614
logger.debug("Stopping server with exit status %d", status)
616
if main_loop_started:
652
625
global main_loop_started
653
626
main_loop_started = False
655
628
parser = OptionParser()
656
629
parser.add_option("-i", "--interface", type="string",
657
metavar="IF", help="Bind to interface IF")
658
parser.add_option("-a", "--address", type="string",
630
default=None, metavar="IF",
631
help="Bind to interface IF")
632
parser.add_option("-a", "--address", type="string", default=None,
659
633
help="Address to listen for requests on")
660
parser.add_option("-p", "--port", type="int",
634
parser.add_option("-p", "--port", type="int", default=None,
661
635
help="Port number to receive requests on")
662
636
parser.add_option("--check", action="store_true", default=False,
663
637
help="Run self-test")
664
638
parser.add_option("--debug", action="store_true", default=False,
665
help="Debug mode; run in foreground and log to"
667
parser.add_option("--priority", type="string", help="GnuTLS"
668
" priority string (see GnuTLS documentation)")
669
parser.add_option("--servicename", type="string", metavar="NAME",
670
help="Zeroconf service name")
671
parser.add_option("--configdir", type="string",
672
default="/etc/mandos", metavar="DIR",
673
help="Directory to search for configuration"
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")
675
646
(options, args) = parser.parse_args()
677
648
if options.check:
679
650
doctest.testmod()
682
# Default values for config file for server-global settings
683
server_defaults = { "interface": "",
688
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
689
"servicename": "Mandos",
692
# Parse config file for server-global settings
693
server_config = ConfigParser.SafeConfigParser(server_defaults)
695
server_config.read(os.path.join(options.configdir, "server.conf"))
696
server_section = "server"
697
# Convert the SafeConfigParser object to a dict
698
server_settings = dict(server_config.items(server_section))
699
# Use getboolean on the boolean config option
700
server_settings["debug"] = server_config.getboolean\
701
(server_section, "debug")
704
# Override the settings from the config file with command line
706
for option in ("interface", "address", "port", "debug",
707
"priority", "servicename", "configdir"):
708
value = getattr(options, option)
709
if value is not None:
710
server_settings[option] = value
712
# Now we have our good server settings in "server_settings"
714
# Parse config file with clients
715
client_defaults = { "timeout": "1h",
717
"checker": "fping -q -- %%(fqdn)s",
719
client_config = ConfigParser.SafeConfigParser(client_defaults)
720
client_config.read(os.path.join(server_settings["configdir"],
724
service = AvahiService(name = server_settings["servicename"],
725
type = "_mandos._tcp", );
726
if server_settings["interface"]:
727
service.interface = if_nametoindex(server_settings["interface"])
654
defaults = { "timeout": "1h",
656
"checker": "fping -q -- %%(fqdn)s",
658
client_config = ConfigParser.SafeConfigParser(defaults)
659
#client_config.readfp(open("global.conf"), "global.conf")
660
client_config.read("mandos-clients.conf")
663
serviceName = options.servicename;
784
720
signal.signal(signal.SIGINT, signal.SIG_IGN)
785
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
786
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
721
signal.signal(signal.SIGHUP, lambda signum, frame: killme())
722
signal.signal(signal.SIGTERM, lambda signum, frame: killme())
788
724
for client in clients:
791
tcp_server = IPv6_TCPServer((server_settings["address"],
792
server_settings["port"]),
727
tcp_server = IPv6_TCPServer((options.address, options.port),
794
settings=server_settings,
796
# Find out what port we got
797
service.port = tcp_server.socket.getsockname()[1]
798
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
799
u" scope_id %d" % tcp_server.socket.getsockname())
801
#service.interface = tcp_server.socket.getsockname()[3]
804
# From the Avahi example code
805
server.connect_to_signal("StateChanged", server_state_changed)
807
server_state_changed(server.GetState())
808
except dbus.exceptions.DBusException, error:
809
logger.critical(u"DBusException: %s", error)
811
# End of Avahi example code
813
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
814
lambda *args, **kwargs:
815
tcp_server.handle_request\
816
(*args[2:], **kwargs) or True)
731
# Find out what random port we got
733
servicePort = tcp_server.socket.getsockname()[1]
734
logger.debug(u"Now listening on port %d", servicePort)
736
if options.interface is not None:
737
global serviceInterface
738
serviceInterface = if_nametoindex(options.interface)
740
# From the Avahi example code
741
server.connect_to_signal("StateChanged", server_state_changed)
743
server_state_changed(server.GetState())
744
except dbus.exceptions.DBusException, error:
745
logger.critical(u"DBusException: %s", error)
747
# End of Avahi example code
749
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
750
lambda *args, **kwargs:
751
tcp_server.handle_request(*args[2:],
818
754
logger.debug("Starting main loop")
819
755
main_loop_started = True
821
except AvahiError, error:
822
logger.critical(u"AvahiError: %s" + unicode(error))
824
757
except KeyboardInterrupt:
828
763
if __name__ == '__main__':