173
170
# End of Avahi example code
176
def _datetime_to_dbus(dt, variant_level=0):
177
"""Convert a UTC datetime.datetime() to a D-Bus type."""
178
return dbus.String(dt.isoformat(), variant_level=variant_level)
181
class Client(dbus.service.Object):
173
class Client(object):
182
174
"""A representation of a client host served by this server.
184
name: string; from the config file, used in log messages and
176
name: string; from the config file, used in log messages
186
177
fingerprint: string (40 or 32 hexadecimal digits); used to
187
178
uniquely identify the client
188
secret: bytestring; sent verbatim (over TLS) to client
189
host: string; available for use by the checker command
190
created: datetime.datetime(); (UTC) object creation
191
last_enabled: datetime.datetime(); (UTC)
193
last_checked_ok: datetime.datetime(); (UTC) or None
194
timeout: datetime.timedelta(); How long from last_checked_ok
195
until this client is invalid
196
interval: datetime.timedelta(); How often to start a new checker
197
disable_hook: If set, called by disable() as disable_hook(self)
198
checker: subprocess.Popen(); a running checker process used
199
to see if the client lives.
200
'None' if no process is running.
179
secret: bytestring; sent verbatim (over TLS) to client
180
host: string; available for use by the checker command
181
created: datetime.datetime(); object creation, not client host
182
last_checked_ok: datetime.datetime() or None if not yet checked OK
183
timeout: datetime.timedelta(); How long from last_checked_ok
184
until this client is invalid
185
interval: datetime.timedelta(); How often to start a new checker
186
stop_hook: If set, called by stop() as stop_hook(self)
187
checker: subprocess.Popen(); a running checker process used
188
to see if the client lives.
189
'None' if no process is running.
201
190
checker_initiator_tag: a gobject event source tag, or None
202
disable_initiator_tag: - '' -
191
stop_initiator_tag: - '' -
203
192
checker_callback_tag: - '' -
204
193
checker_command: string; External command which is run to check if
205
194
client lives. %() expansions are done at
206
195
runtime with vars(self) as dict, so that for
207
196
instance %(name)s can be used in the command.
208
current_checker_command: string; current running checker_command
209
use_dbus: bool(); Whether to provide D-Bus interface and signals
210
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
198
_timeout: Real variable for 'timeout'
199
_interval: Real variable for 'interval'
200
_timeout_milliseconds: Used when calling gobject.timeout_add()
201
_interval_milliseconds: - '' -
212
def timeout_milliseconds(self):
213
"Return the 'timeout' attribute in milliseconds"
214
return ((self.timeout.days * 24 * 60 * 60 * 1000)
215
+ (self.timeout.seconds * 1000)
216
+ (self.timeout.microseconds // 1000))
218
def interval_milliseconds(self):
219
"Return the 'interval' attribute in milliseconds"
220
return ((self.interval.days * 24 * 60 * 60 * 1000)
221
+ (self.interval.seconds * 1000)
222
+ (self.interval.microseconds // 1000))
224
def __init__(self, name = None, disable_hook=None, config=None,
203
def _set_timeout(self, timeout):
204
"Setter function for 'timeout' attribute"
205
self._timeout = timeout
206
self._timeout_milliseconds = ((self.timeout.days
207
* 24 * 60 * 60 * 1000)
208
+ (self.timeout.seconds * 1000)
209
+ (self.timeout.microseconds
211
timeout = property(lambda self: self._timeout,
214
def _set_interval(self, interval):
215
"Setter function for 'interval' attribute"
216
self._interval = interval
217
self._interval_milliseconds = ((self.interval.days
218
* 24 * 60 * 60 * 1000)
219
+ (self.interval.seconds
221
+ (self.interval.microseconds
223
interval = property(lambda self: self._interval,
226
def __init__(self, name = None, stop_hook=None, config=None):
226
227
"""Note: the 'checker' key in 'config' sets the
227
228
'checker_command' attribute and *not* the 'checker'
230
230
if config is None:
232
233
logger.debug(u"Creating client %r", self.name)
233
self.use_dbus = False # During __init__
234
234
# Uppercase and remove spaces from fingerprint for later
235
235
# comparison purposes with return value from the fingerprint()
237
self.fingerprint = (config["fingerprint"].upper()
237
self.fingerprint = config["fingerprint"].upper()\
239
239
logger.debug(u" Fingerprint: %s", self.fingerprint)
240
240
if "secret" in config:
241
241
self.secret = config["secret"].decode(u"base64")
242
242
elif "secfile" in config:
243
with closing(open(os.path.expanduser
245
(config["secfile"])))) as secfile:
246
self.secret = secfile.read()
243
secfile = open(os.path.expanduser(os.path.expandvars
244
(config["secfile"])))
245
self.secret = secfile.read()
248
248
raise TypeError(u"No secret or secfile for client %s"
250
250
self.host = config.get("host", "")
251
self.created = datetime.datetime.utcnow()
253
self.last_enabled = None
251
self.created = datetime.datetime.now()
254
252
self.last_checked_ok = None
255
253
self.timeout = string_to_delta(config["timeout"])
256
254
self.interval = string_to_delta(config["interval"])
257
self.disable_hook = disable_hook
255
self.stop_hook = stop_hook
258
256
self.checker = None
259
257
self.checker_initiator_tag = None
260
self.disable_initiator_tag = None
258
self.stop_initiator_tag = None
261
259
self.checker_callback_tag = None
262
self.checker_command = config["checker"]
263
self.current_checker_command = None
264
self.last_connect = None
265
# Only now, when this client is initialized, can it show up on
267
self.use_dbus = use_dbus
269
self.dbus_object_path = (dbus.ObjectPath
271
+ self.name.replace(".", "_")))
272
dbus.service.Object.__init__(self, bus,
273
self.dbus_object_path)
260
self.check_command = config["checker"]
276
262
"""Start this client's checker and timeout hooks"""
277
self.last_enabled = datetime.datetime.utcnow()
278
263
# Schedule a new checker to be started an 'interval' from now,
279
264
# and every interval from then on.
280
self.checker_initiator_tag = (gobject.timeout_add
281
(self.interval_milliseconds(),
265
self.checker_initiator_tag = gobject.timeout_add\
266
(self._interval_milliseconds,
283
268
# Also start a new checker *right now*.
284
269
self.start_checker()
285
# Schedule a disable() when 'timeout' has passed
286
self.disable_initiator_tag = (gobject.timeout_add
287
(self.timeout_milliseconds(),
292
self.PropertyChanged(dbus.String(u"enabled"),
293
dbus.Boolean(True, variant_level=1))
294
self.PropertyChanged(dbus.String(u"last_enabled"),
295
(_datetime_to_dbus(self.last_enabled,
299
"""Disable this client."""
300
if not getattr(self, "enabled", False):
270
# Schedule a stop() when 'timeout' has passed
271
self.stop_initiator_tag = gobject.timeout_add\
272
(self._timeout_milliseconds,
276
The possibility that a client might be restarted is left open,
277
but not currently used."""
278
# If this client doesn't have a secret, it is already stopped.
279
if hasattr(self, "secret") and self.secret:
280
logger.info(u"Stopping client %s", self.name)
302
logger.info(u"Disabling client %s", self.name)
303
if getattr(self, "disable_initiator_tag", False):
304
gobject.source_remove(self.disable_initiator_tag)
305
self.disable_initiator_tag = None
284
if getattr(self, "stop_initiator_tag", False):
285
gobject.source_remove(self.stop_initiator_tag)
286
self.stop_initiator_tag = None
306
287
if getattr(self, "checker_initiator_tag", False):
307
288
gobject.source_remove(self.checker_initiator_tag)
308
289
self.checker_initiator_tag = None
309
290
self.stop_checker()
310
if self.disable_hook:
311
self.disable_hook(self)
315
self.PropertyChanged(dbus.String(u"enabled"),
316
dbus.Boolean(False, variant_level=1))
317
293
# Do not run this again if called by a gobject.timeout_add
320
295
def __del__(self):
321
self.disable_hook = None
324
def checker_callback(self, pid, condition, command):
296
self.stop_hook = None
298
def checker_callback(self, pid, condition):
325
299
"""The checker has completed, so take appropriate actions."""
300
now = datetime.datetime.now()
326
301
self.checker_callback_tag = None
327
302
self.checker = None
330
self.PropertyChanged(dbus.String(u"checker_running"),
331
dbus.Boolean(False, variant_level=1))
332
if os.WIFEXITED(condition):
333
exitstatus = os.WEXITSTATUS(condition)
335
logger.info(u"Checker for %(name)s succeeded",
339
logger.info(u"Checker for %(name)s failed",
343
self.CheckerCompleted(dbus.Int16(exitstatus),
344
dbus.Int64(condition),
345
dbus.String(command))
303
if os.WIFEXITED(condition) \
304
and (os.WEXITSTATUS(condition) == 0):
305
logger.info(u"Checker for %(name)s succeeded",
307
self.last_checked_ok = now
308
gobject.source_remove(self.stop_initiator_tag)
309
self.stop_initiator_tag = gobject.timeout_add\
310
(self._timeout_milliseconds,
312
elif not os.WIFEXITED(condition):
347
313
logger.warning(u"Checker for %(name)s crashed?",
351
self.CheckerCompleted(dbus.Int16(-1),
352
dbus.Int64(condition),
353
dbus.String(command))
355
def checked_ok(self):
356
"""Bump up the timeout for this client.
357
This should only be called when the client has been seen,
360
self.last_checked_ok = datetime.datetime.utcnow()
361
gobject.source_remove(self.disable_initiator_tag)
362
self.disable_initiator_tag = (gobject.timeout_add
363
(self.timeout_milliseconds(),
367
self.PropertyChanged(
368
dbus.String(u"last_checked_ok"),
369
(_datetime_to_dbus(self.last_checked_ok,
316
logger.info(u"Checker for %(name)s failed",
372
318
def start_checker(self):
373
319
"""Start a new checker subprocess if one is not running.
374
320
If a checker already exists, leave it running and do
456
377
if error.errno != errno.ESRCH: # No such process
458
379
self.checker = None
460
self.PropertyChanged(dbus.String(u"checker_running"),
461
dbus.Boolean(False, variant_level=1))
463
380
def still_valid(self):
464
381
"""Has the timeout not yet passed for this client?"""
465
if not getattr(self, "enabled", False):
467
now = datetime.datetime.utcnow()
382
now = datetime.datetime.now()
468
383
if self.last_checked_ok is None:
469
384
return now < (self.created + self.timeout)
471
386
return now < (self.last_checked_ok + self.timeout)
473
## D-Bus methods & signals
474
_interface = u"se.bsnet.fukt.Mandos.Client"
477
CheckedOK = dbus.service.method(_interface)(checked_ok)
478
CheckedOK.__name__ = "CheckedOK"
480
# CheckerCompleted - signal
481
@dbus.service.signal(_interface, signature="nxs")
482
def CheckerCompleted(self, exitcode, waitstatus, command):
486
# CheckerStarted - signal
487
@dbus.service.signal(_interface, signature="s")
488
def CheckerStarted(self, command):
492
# GetAllProperties - method
493
@dbus.service.method(_interface, out_signature="a{sv}")
494
def GetAllProperties(self):
496
return dbus.Dictionary({
498
dbus.String(self.name, variant_level=1),
499
dbus.String("fingerprint"):
500
dbus.String(self.fingerprint, variant_level=1),
502
dbus.String(self.host, variant_level=1),
503
dbus.String("created"):
504
_datetime_to_dbus(self.created, variant_level=1),
505
dbus.String("last_enabled"):
506
(_datetime_to_dbus(self.last_enabled,
508
if self.last_enabled is not None
509
else dbus.Boolean(False, variant_level=1)),
510
dbus.String("enabled"):
511
dbus.Boolean(self.enabled, variant_level=1),
512
dbus.String("last_checked_ok"):
513
(_datetime_to_dbus(self.last_checked_ok,
515
if self.last_checked_ok is not None
516
else dbus.Boolean (False, variant_level=1)),
517
dbus.String("timeout"):
518
dbus.UInt64(self.timeout_milliseconds(),
520
dbus.String("interval"):
521
dbus.UInt64(self.interval_milliseconds(),
523
dbus.String("checker"):
524
dbus.String(self.checker_command,
526
dbus.String("checker_running"):
527
dbus.Boolean(self.checker is not None,
529
dbus.String("object_path"):
530
dbus.ObjectPath(self.dbus_object_path,
534
# IsStillValid - method
535
IsStillValid = (dbus.service.method(_interface, out_signature="b")
537
IsStillValid.__name__ = "IsStillValid"
539
# PropertyChanged - signal
540
@dbus.service.signal(_interface, signature="sv")
541
def PropertyChanged(self, property, value):
545
# SetChecker - method
546
@dbus.service.method(_interface, in_signature="s")
547
def SetChecker(self, checker):
548
"D-Bus setter method"
549
self.checker_command = checker
551
self.PropertyChanged(dbus.String(u"checker"),
552
dbus.String(self.checker_command,
556
@dbus.service.method(_interface, in_signature="s")
557
def SetHost(self, host):
558
"D-Bus setter method"
561
self.PropertyChanged(dbus.String(u"host"),
562
dbus.String(self.host, variant_level=1))
564
# SetInterval - method
565
@dbus.service.method(_interface, in_signature="t")
566
def SetInterval(self, milliseconds):
567
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
569
self.PropertyChanged(dbus.String(u"interval"),
570
(dbus.UInt64(self.interval_milliseconds(),
574
@dbus.service.method(_interface, in_signature="ay",
576
def SetSecret(self, secret):
577
"D-Bus setter method"
578
self.secret = str(secret)
580
# SetTimeout - method
581
@dbus.service.method(_interface, in_signature="t")
582
def SetTimeout(self, milliseconds):
583
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
585
self.PropertyChanged(dbus.String(u"timeout"),
586
(dbus.UInt64(self.timeout_milliseconds(),
590
Enable = dbus.service.method(_interface)(enable)
591
Enable.__name__ = "Enable"
593
# StartChecker - method
594
@dbus.service.method(_interface)
595
def StartChecker(self):
600
@dbus.service.method(_interface)
605
# StopChecker - method
606
StopChecker = dbus.service.method(_interface)(stop_checker)
607
StopChecker.__name__ = "StopChecker"
612
389
def peer_certificate(session):
613
390
"Return the peer's OpenPGP certificate as a bytestring"
614
391
# If not an OpenPGP certificate...
615
if (gnutls.library.functions
616
.gnutls_certificate_type_get(session._c_object)
617
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
392
if gnutls.library.functions.gnutls_certificate_type_get\
393
(session._c_object) \
394
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
618
395
# ...do the normal thing
619
396
return session.peer_certificate
620
list_size = ctypes.c_uint(1)
621
cert_list = (gnutls.library.functions
622
.gnutls_certificate_get_peers
623
(session._c_object, ctypes.byref(list_size)))
624
if not bool(cert_list) and list_size.value != 0:
625
raise gnutls.errors.GNUTLSError("error getting peer"
397
list_size = ctypes.c_uint()
398
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
399
(session._c_object, ctypes.byref(list_size))
627
400
if list_size.value == 0:
629
402
cert = cert_list[0]
678
448
def handle(self):
679
449
logger.info(u"TCP connection from: %s",
680
unicode(self.client_address))
681
logger.debug(u"Pipe: %d", self.server.pipe[1])
682
# Open IPC pipe to parent process
683
with closing(os.fdopen(self.server.pipe[1], "w", 1)) as ipc:
684
session = (gnutls.connection
685
.ClientSession(self.request,
689
line = self.request.makefile().readline()
690
logger.debug(u"Protocol version: %r", line)
692
if int(line.strip().split()[0]) > 1:
694
except (ValueError, IndexError, RuntimeError), error:
695
logger.error(u"Unknown protocol version: %s", error)
698
# Note: gnutls.connection.X509Credentials is really a
699
# generic GnuTLS certificate credentials object so long as
700
# no X.509 keys are added to it. Therefore, we can use it
701
# here despite using OpenPGP certificates.
703
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
704
# "+AES-256-CBC", "+SHA1",
705
# "+COMP-NULL", "+CTYPE-OPENPGP",
707
# Use a fallback default, since this MUST be set.
708
priority = self.server.settings.get("priority", "NORMAL")
709
(gnutls.library.functions
710
.gnutls_priority_set_direct(session._c_object,
715
except gnutls.errors.GNUTLSError, error:
716
logger.warning(u"Handshake failed: %s", error)
717
# Do not run session.bye() here: the session is not
718
# established. Just abandon the request.
720
logger.debug(u"Handshake succeeded")
722
fpr = fingerprint(peer_certificate(session))
723
except (TypeError, gnutls.errors.GNUTLSError), error:
724
logger.warning(u"Bad certificate: %s", error)
727
logger.debug(u"Fingerprint: %s", fpr)
729
for c in self.server.clients:
730
if c.fingerprint == fpr:
734
logger.warning(u"Client not found for fingerprint: %s",
736
ipc.write("NOTFOUND %s\n" % fpr)
739
# Have to check if client.still_valid(), since it is
740
# possible that the client timed out while establishing
741
# the GnuTLS session.
742
if not client.still_valid():
743
logger.warning(u"Client %(name)s is invalid",
745
ipc.write("INVALID %s\n" % client.name)
748
ipc.write("SENDING %s\n" % client.name)
750
while sent_size < len(client.secret):
751
sent = session.send(client.secret[sent_size:])
752
logger.debug(u"Sent: %d, remaining: %d",
753
sent, len(client.secret)
754
- (sent_size + sent))
759
class ForkingMixInWithPipe(SocketServer.ForkingMixIn, object):
760
"""Like SocketServer.ForkingMixIn, but also pass a pipe.
761
Assumes a gobject.MainLoop event loop.
763
def process_request(self, request, client_address):
764
"""This overrides and wraps the original process_request().
765
This function creates a new pipe in self.pipe
767
self.pipe = os.pipe()
768
super(ForkingMixInWithPipe,
769
self).process_request(request, client_address)
770
os.close(self.pipe[1]) # close write end
771
# Call "handle_ipc" for both data and EOF events
772
gobject.io_add_watch(self.pipe[0],
773
gobject.IO_IN | gobject.IO_HUP,
775
def handle_ipc(source, condition):
776
"""Dummy function; override as necessary"""
781
class IPv6_TCPServer(ForkingMixInWithPipe,
782
SocketServer.TCPServer, object):
783
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
450
unicode(self.client_address))
451
session = gnutls.connection.ClientSession\
452
(self.request, gnutls.connection.X509Credentials())
454
line = self.request.makefile().readline()
455
logger.debug(u"Protocol version: %r", line)
457
if int(line.strip().split()[0]) > 1:
459
except (ValueError, IndexError, RuntimeError), error:
460
logger.error(u"Unknown protocol version: %s", error)
463
# Note: gnutls.connection.X509Credentials is really a generic
464
# GnuTLS certificate credentials object so long as no X.509
465
# keys are added to it. Therefore, we can use it here despite
466
# using OpenPGP certificates.
468
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
469
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
471
priority = "NORMAL" # Fallback default, since this
473
if self.server.settings["priority"]:
474
priority = self.server.settings["priority"]
475
gnutls.library.functions.gnutls_priority_set_direct\
476
(session._c_object, priority, None)
480
except gnutls.errors.GNUTLSError, error:
481
logger.warning(u"Handshake failed: %s", error)
482
# Do not run session.bye() here: the session is not
483
# established. Just abandon the request.
486
fpr = fingerprint(peer_certificate(session))
487
except (TypeError, gnutls.errors.GNUTLSError), error:
488
logger.warning(u"Bad certificate: %s", error)
491
logger.debug(u"Fingerprint: %s", fpr)
493
for c in self.server.clients:
494
if c.fingerprint == fpr:
498
logger.warning(u"Client not found for fingerprint: %s",
502
# Have to check if client.still_valid(), since it is possible
503
# that the client timed out while establishing the GnuTLS
505
if not client.still_valid():
506
logger.warning(u"Client %(name)s is invalid",
511
while sent_size < len(client.secret):
512
sent = session.send(client.secret[sent_size:])
513
logger.debug(u"Sent: %d, remaining: %d",
514
sent, len(client.secret)
515
- (sent_size + sent))
520
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
521
"""IPv6 TCP server. Accepts 'None' as address and/or port.
785
523
settings: Server settings
786
524
clients: Set() of Client objects
1210
880
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1211
881
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1214
class MandosServer(dbus.service.Object):
1215
"""A D-Bus proxy object"""
1217
dbus.service.Object.__init__(self, bus, "/")
1218
_interface = u"se.bsnet.fukt.Mandos"
1220
@dbus.service.signal(_interface, signature="oa{sv}")
1221
def ClientAdded(self, objpath, properties):
1225
@dbus.service.signal(_interface, signature="os")
1226
def ClientRemoved(self, objpath, name):
1230
@dbus.service.method(_interface, out_signature="ao")
1231
def GetAllClients(self):
1233
return dbus.Array(c.dbus_object_path for c in clients)
1235
@dbus.service.method(_interface, out_signature="a{oa{sv}}")
1236
def GetAllClientsWithProperties(self):
1238
return dbus.Dictionary(
1239
((c.dbus_object_path, c.GetAllProperties())
1243
@dbus.service.method(_interface, in_signature="o")
1244
def RemoveClient(self, object_path):
1247
if c.dbus_object_path == object_path:
1249
# Don't signal anything except ClientRemoved
1253
self.ClientRemoved(object_path, c.name)
1259
mandos_server = MandosServer()
1261
883
for client in clients:
1264
mandos_server.ClientAdded(client.dbus_object_path,
1265
client.GetAllProperties())
1268
886
tcp_server.enable()
1269
887
tcp_server.server_activate()
1271
889
# Find out what port we got
1272
890
service.port = tcp_server.socket.getsockname()[1]
1274
logger.info(u"Now listening on address %r, port %d,"
1275
" flowinfo %d, scope_id %d"
1276
% tcp_server.socket.getsockname())
1278
logger.info(u"Now listening on address %r, port %d"
1279
% tcp_server.socket.getsockname())
891
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
892
u" scope_id %d" % tcp_server.socket.getsockname())
1281
894
#service.interface = tcp_server.socket.getsockname()[3]