165
170
# End of Avahi example code
168
class Client(object):
173
def _datetime_to_dbus(dt, variant_level=0):
174
"""Convert a UTC datetime.datetime() to a D-Bus type."""
175
return dbus.String(dt.isoformat(), variant_level=variant_level)
178
class Client(dbus.service.Object):
169
179
"""A representation of a client host served by this server.
171
name: string; from the config file, used in log messages
181
name: string; from the config file, used in log messages and
172
183
fingerprint: string (40 or 32 hexadecimal digits); used to
173
184
uniquely identify the client
174
secret: bytestring; sent verbatim (over TLS) to client
175
host: string; available for use by the checker command
176
created: datetime.datetime(); object creation, not client host
177
last_checked_ok: datetime.datetime() or None if not yet checked OK
178
timeout: datetime.timedelta(); How long from last_checked_ok
179
until this client is invalid
180
interval: datetime.timedelta(); How often to start a new checker
181
stop_hook: If set, called by stop() as stop_hook(self)
182
checker: subprocess.Popen(); a running checker process used
183
to see if the client lives.
184
'None' if no process is running.
185
secret: bytestring; sent verbatim (over TLS) to client
186
host: string; available for use by the checker command
187
created: datetime.datetime(); (UTC) object creation
188
last_enabled: datetime.datetime(); (UTC)
190
last_checked_ok: datetime.datetime(); (UTC) or None
191
timeout: datetime.timedelta(); How long from last_checked_ok
192
until this client is invalid
193
interval: datetime.timedelta(); How often to start a new checker
194
disable_hook: If set, called by disable() as disable_hook(self)
195
checker: subprocess.Popen(); a running checker process used
196
to see if the client lives.
197
'None' if no process is running.
185
198
checker_initiator_tag: a gobject event source tag, or None
186
stop_initiator_tag: - '' -
199
disable_initiator_tag: - '' -
187
200
checker_callback_tag: - '' -
188
201
checker_command: string; External command which is run to check if
189
202
client lives. %() expansions are done at
190
203
runtime with vars(self) as dict, so that for
191
204
instance %(name)s can be used in the command.
193
_timeout: Real variable for 'timeout'
194
_interval: Real variable for 'interval'
195
_timeout_milliseconds: Used when calling gobject.timeout_add()
196
_interval_milliseconds: - '' -
205
use_dbus: bool(); Whether to provide D-Bus interface and signals
206
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
198
def _set_timeout(self, timeout):
199
"Setter function for 'timeout' attribute"
200
self._timeout = timeout
201
self._timeout_milliseconds = ((self.timeout.days
202
* 24 * 60 * 60 * 1000)
203
+ (self.timeout.seconds * 1000)
204
+ (self.timeout.microseconds
206
timeout = property(lambda self: self._timeout,
209
def _set_interval(self, interval):
210
"Setter function for 'interval' attribute"
211
self._interval = interval
212
self._interval_milliseconds = ((self.interval.days
213
* 24 * 60 * 60 * 1000)
214
+ (self.interval.seconds
216
+ (self.interval.microseconds
218
interval = property(lambda self: self._interval,
221
def __init__(self, name = None, stop_hook=None, config={}):
208
def timeout_milliseconds(self):
209
"Return the 'timeout' attribute in milliseconds"
210
return ((self.timeout.days * 24 * 60 * 60 * 1000)
211
+ (self.timeout.seconds * 1000)
212
+ (self.timeout.microseconds // 1000))
214
def interval_milliseconds(self):
215
"Return the 'interval' attribute in milliseconds"
216
return ((self.interval.days * 24 * 60 * 60 * 1000)
217
+ (self.interval.seconds * 1000)
218
+ (self.interval.microseconds // 1000))
220
def __init__(self, name = None, disable_hook=None, config=None,
222
222
"""Note: the 'checker' key in 'config' sets the
223
223
'checker_command' attribute and *not* the 'checker'
226
228
logger.debug(u"Creating client %r", self.name)
229
self.use_dbus = use_dbus
231
self.dbus_object_path = (dbus.ObjectPath
233
+ self.name.replace(".", "_")))
234
dbus.service.Object.__init__(self, bus,
235
self.dbus_object_path)
227
236
# Uppercase and remove spaces from fingerprint for later
228
237
# comparison purposes with return value from the fingerprint()
230
self.fingerprint = config["fingerprint"].upper()\
239
self.fingerprint = (config["fingerprint"].upper()
232
241
logger.debug(u" Fingerprint: %s", self.fingerprint)
233
242
if "secret" in config:
234
243
self.secret = config["secret"].decode(u"base64")
235
244
elif "secfile" in config:
236
sf = open(config["secfile"])
237
self.secret = sf.read()
245
with closing(open(os.path.expanduser
247
(config["secfile"])))) as secfile:
248
self.secret = secfile.read()
240
250
raise TypeError(u"No secret or secfile for client %s"
242
252
self.host = config.get("host", "")
243
self.created = datetime.datetime.now()
253
self.created = datetime.datetime.utcnow()
255
self.last_enabled = None
244
256
self.last_checked_ok = None
245
257
self.timeout = string_to_delta(config["timeout"])
246
258
self.interval = string_to_delta(config["interval"])
247
self.stop_hook = stop_hook
259
self.disable_hook = disable_hook
248
260
self.checker = None
249
261
self.checker_initiator_tag = None
250
self.stop_initiator_tag = None
262
self.disable_initiator_tag = None
251
263
self.checker_callback_tag = None
252
self.check_command = config["checker"]
264
self.checker_command = config["checker"]
254
267
"""Start this client's checker and timeout hooks"""
268
self.last_enabled = datetime.datetime.utcnow()
255
269
# Schedule a new checker to be started an 'interval' from now,
256
270
# and every interval from then on.
257
self.checker_initiator_tag = gobject.timeout_add\
258
(self._interval_milliseconds,
271
self.checker_initiator_tag = (gobject.timeout_add
272
(self.interval_milliseconds(),
260
274
# Also start a new checker *right now*.
261
275
self.start_checker()
262
# Schedule a stop() when 'timeout' has passed
263
self.stop_initiator_tag = gobject.timeout_add\
264
(self._timeout_milliseconds,
268
The possibility that a client might be restarted is left open,
269
but not currently used."""
270
# If this client doesn't have a secret, it is already stopped.
271
if hasattr(self, "secret") and self.secret:
272
logger.info(u"Stopping client %s", self.name)
276
# Schedule a disable() when 'timeout' has passed
277
self.disable_initiator_tag = (gobject.timeout_add
278
(self.timeout_milliseconds(),
283
self.PropertyChanged(dbus.String(u"enabled"),
284
dbus.Boolean(True, variant_level=1))
285
self.PropertyChanged(dbus.String(u"last_enabled"),
286
(_datetime_to_dbus(self.last_enabled,
290
"""Disable this client."""
291
if not getattr(self, "enabled", False):
276
if getattr(self, "stop_initiator_tag", False):
277
gobject.source_remove(self.stop_initiator_tag)
278
self.stop_initiator_tag = None
293
logger.info(u"Disabling client %s", self.name)
294
if getattr(self, "disable_initiator_tag", False):
295
gobject.source_remove(self.disable_initiator_tag)
296
self.disable_initiator_tag = None
279
297
if getattr(self, "checker_initiator_tag", False):
280
298
gobject.source_remove(self.checker_initiator_tag)
281
299
self.checker_initiator_tag = None
282
300
self.stop_checker()
301
if self.disable_hook:
302
self.disable_hook(self)
306
self.PropertyChanged(dbus.String(u"enabled"),
307
dbus.Boolean(False, variant_level=1))
285
308
# Do not run this again if called by a gobject.timeout_add
287
311
def __del__(self):
288
self.stop_hook = None
290
def checker_callback(self, pid, condition):
312
self.disable_hook = None
315
def checker_callback(self, pid, condition, command):
291
316
"""The checker has completed, so take appropriate actions."""
292
now = datetime.datetime.now()
293
317
self.checker_callback_tag = None
294
318
self.checker = None
295
if os.WIFEXITED(condition) \
296
and (os.WEXITSTATUS(condition) == 0):
321
self.PropertyChanged(dbus.String(u"checker_running"),
322
dbus.Boolean(False, variant_level=1))
323
if (os.WIFEXITED(condition)
324
and (os.WEXITSTATUS(condition) == 0)):
297
325
logger.info(u"Checker for %(name)s succeeded",
299
self.last_checked_ok = now
300
gobject.source_remove(self.stop_initiator_tag)
301
self.stop_initiator_tag = gobject.timeout_add\
302
(self._timeout_milliseconds,
329
self.CheckerCompleted(dbus.Boolean(True),
330
dbus.UInt16(condition),
331
dbus.String(command))
304
333
elif not os.WIFEXITED(condition):
305
334
logger.warning(u"Checker for %(name)s crashed?",
338
self.CheckerCompleted(dbus.Boolean(False),
339
dbus.UInt16(condition),
340
dbus.String(command))
308
342
logger.info(u"Checker for %(name)s failed",
346
self.CheckerCompleted(dbus.Boolean(False),
347
dbus.UInt16(condition),
348
dbus.String(command))
350
def bump_timeout(self):
351
"""Bump up the timeout for this client.
352
This should only be called when the client has been seen,
355
self.last_checked_ok = datetime.datetime.utcnow()
356
gobject.source_remove(self.disable_initiator_tag)
357
self.disable_initiator_tag = (gobject.timeout_add
358
(self.timeout_milliseconds(),
362
self.PropertyChanged(
363
dbus.String(u"last_checked_ok"),
364
(_datetime_to_dbus(self.last_checked_ok,
310
367
def start_checker(self):
311
368
"""Start a new checker subprocess if one is not running.
312
369
If a checker already exists, leave it running and do
365
434
if error.errno != errno.ESRCH: # No such process
367
436
self.checker = None
438
self.PropertyChanged(dbus.String(u"checker_running"),
439
dbus.Boolean(False, variant_level=1))
368
441
def still_valid(self):
369
442
"""Has the timeout not yet passed for this client?"""
370
now = datetime.datetime.now()
443
if not getattr(self, "enabled", False):
445
now = datetime.datetime.utcnow()
371
446
if self.last_checked_ok is None:
372
447
return now < (self.created + self.timeout)
374
449
return now < (self.last_checked_ok + self.timeout)
451
## D-Bus methods & signals
452
_interface = u"org.mandos_system.Mandos.Client"
454
# BumpTimeout - method
455
BumpTimeout = dbus.service.method(_interface)(bump_timeout)
456
BumpTimeout.__name__ = "BumpTimeout"
458
# CheckerCompleted - signal
459
@dbus.service.signal(_interface, signature="bqs")
460
def CheckerCompleted(self, success, condition, command):
464
# CheckerStarted - signal
465
@dbus.service.signal(_interface, signature="s")
466
def CheckerStarted(self, command):
470
# GetAllProperties - method
471
@dbus.service.method(_interface, out_signature="a{sv}")
472
def GetAllProperties(self):
474
return dbus.Dictionary({
476
dbus.String(self.name, variant_level=1),
477
dbus.String("fingerprint"):
478
dbus.String(self.fingerprint, variant_level=1),
480
dbus.String(self.host, variant_level=1),
481
dbus.String("created"):
482
_datetime_to_dbus(self.created, variant_level=1),
483
dbus.String("last_enabled"):
484
(_datetime_to_dbus(self.last_enabled,
486
if self.last_enabled is not None
487
else dbus.Boolean(False, variant_level=1)),
488
dbus.String("enabled"):
489
dbus.Boolean(self.enabled, variant_level=1),
490
dbus.String("last_checked_ok"):
491
(_datetime_to_dbus(self.last_checked_ok,
493
if self.last_checked_ok is not None
494
else dbus.Boolean (False, variant_level=1)),
495
dbus.String("timeout"):
496
dbus.UInt64(self.timeout_milliseconds(),
498
dbus.String("interval"):
499
dbus.UInt64(self.interval_milliseconds(),
501
dbus.String("checker"):
502
dbus.String(self.checker_command,
504
dbus.String("checker_running"):
505
dbus.Boolean(self.checker is not None,
507
dbus.String("object_path"):
508
dbus.ObjectPath(self.dbus_object_path,
512
# IsStillValid - method
513
IsStillValid = (dbus.service.method(_interface, out_signature="b")
515
IsStillValid.__name__ = "IsStillValid"
517
# PropertyChanged - signal
518
@dbus.service.signal(_interface, signature="sv")
519
def PropertyChanged(self, property, value):
523
# SetChecker - method
524
@dbus.service.method(_interface, in_signature="s")
525
def SetChecker(self, checker):
526
"D-Bus setter method"
527
self.checker_command = checker
529
self.PropertyChanged(dbus.String(u"checker"),
530
dbus.String(self.checker_command,
534
@dbus.service.method(_interface, in_signature="s")
535
def SetHost(self, host):
536
"D-Bus setter method"
539
self.PropertyChanged(dbus.String(u"host"),
540
dbus.String(self.host, variant_level=1))
542
# SetInterval - method
543
@dbus.service.method(_interface, in_signature="t")
544
def SetInterval(self, milliseconds):
545
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
547
self.PropertyChanged(dbus.String(u"interval"),
548
(dbus.UInt64(self.interval_milliseconds(),
552
@dbus.service.method(_interface, in_signature="ay",
554
def SetSecret(self, secret):
555
"D-Bus setter method"
556
self.secret = str(secret)
558
# SetTimeout - method
559
@dbus.service.method(_interface, in_signature="t")
560
def SetTimeout(self, milliseconds):
561
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
563
self.PropertyChanged(dbus.String(u"timeout"),
564
(dbus.UInt64(self.timeout_milliseconds(),
568
Enable = dbus.service.method(_interface)(enable)
569
Enable.__name__ = "Enable"
571
# StartChecker - method
572
@dbus.service.method(_interface)
573
def StartChecker(self):
578
@dbus.service.method(_interface)
583
# StopChecker - method
584
StopChecker = dbus.service.method(_interface)(stop_checker)
585
StopChecker.__name__ = "StopChecker"
377
590
def peer_certificate(session):
378
591
"Return the peer's OpenPGP certificate as a bytestring"
379
592
# If not an OpenPGP certificate...
380
if gnutls.library.functions.gnutls_certificate_type_get\
381
(session._c_object) \
382
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
593
if (gnutls.library.functions
594
.gnutls_certificate_type_get(session._c_object)
595
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
383
596
# ...do the normal thing
384
597
return session.peer_certificate
385
598
list_size = ctypes.c_uint()
386
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
387
(session._c_object, ctypes.byref(list_size))
599
cert_list = (gnutls.library.functions
600
.gnutls_certificate_get_peers
601
(session._c_object, ctypes.byref(list_size)))
388
602
if list_size.value == 0:
390
604
cert = cert_list[0]
394
608
def fingerprint(openpgp):
395
609
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
396
610
# New GnuTLS "datum" with the OpenPGP public key
397
datum = gnutls.library.types.gnutls_datum_t\
398
(ctypes.cast(ctypes.c_char_p(openpgp),
399
ctypes.POINTER(ctypes.c_ubyte)),
400
ctypes.c_uint(len(openpgp)))
611
datum = (gnutls.library.types
612
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
615
ctypes.c_uint(len(openpgp))))
401
616
# New empty GnuTLS certificate
402
617
crt = gnutls.library.types.gnutls_openpgp_crt_t()
403
gnutls.library.functions.gnutls_openpgp_crt_init\
618
(gnutls.library.functions
619
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
405
620
# Import the OpenPGP public key into the certificate
406
gnutls.library.functions.gnutls_openpgp_crt_import\
407
(crt, ctypes.byref(datum),
408
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
621
(gnutls.library.functions
622
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
623
gnutls.library.constants
624
.GNUTLS_OPENPGP_FMT_RAW))
625
# Verify the self signature in the key
626
crtverify = ctypes.c_uint()
627
(gnutls.library.functions
628
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
629
if crtverify.value != 0:
630
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
631
raise gnutls.errors.CertificateSecurityError("Verify failed")
409
632
# New buffer for the fingerprint
410
buffer = ctypes.create_string_buffer(20)
411
buffer_length = ctypes.c_size_t()
633
buf = ctypes.create_string_buffer(20)
634
buf_len = ctypes.c_size_t()
412
635
# Get the fingerprint from the certificate into the buffer
413
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
414
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
636
(gnutls.library.functions
637
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
638
ctypes.byref(buf_len)))
415
639
# Deinit the certificate
416
640
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
417
641
# Convert the buffer to a Python bytestring
418
fpr = ctypes.string_at(buffer, buffer_length.value)
642
fpr = ctypes.string_at(buf, buf_len.value)
419
643
# Convert the bytestring to hexadecimal notation
420
644
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
424
class tcp_handler(SocketServer.BaseRequestHandler, object):
648
class TCP_handler(SocketServer.BaseRequestHandler, object):
425
649
"""A TCP request handler class.
426
650
Instantiated by IPv6_TCPServer for each request to handle it.
427
651
Note: This will run in its own forked process."""
429
653
def handle(self):
430
654
logger.info(u"TCP connection from: %s",
431
unicode(self.client_address))
432
session = gnutls.connection.ClientSession\
433
(self.request, gnutls.connection.X509Credentials())
655
unicode(self.client_address))
656
session = (gnutls.connection
657
.ClientSession(self.request,
435
661
line = self.request.makefile().readline()
436
662
logger.debug(u"Protocol version: %r", line)
563
797
datetime.timedelta(1)
564
798
>>> string_to_delta(u'1w')
565
799
datetime.timedelta(7)
800
>>> string_to_delta('5m 30s')
801
datetime.timedelta(0, 330)
568
suffix=unicode(interval[-1])
569
value=int(interval[:-1])
571
delta = datetime.timedelta(value)
573
delta = datetime.timedelta(0, value)
575
delta = datetime.timedelta(0, 0, 0, 0, value)
577
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
579
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
803
timevalue = datetime.timedelta(0)
804
for s in interval.split():
806
suffix = unicode(s[-1])
809
delta = datetime.timedelta(value)
811
delta = datetime.timedelta(0, value)
813
delta = datetime.timedelta(0, 0, 0, 0, value)
815
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
817
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
820
except (ValueError, IndexError):
582
except (ValueError, IndexError):
587
826
def server_state_changed(state):
588
827
"""Derived from the Avahi example code"""
589
828
if state == avahi.SERVER_COLLISION:
590
logger.error(u"Server name collision")
829
logger.error(u"Zeroconf server name collision")
592
831
elif state == avahi.SERVER_RUNNING:
809
1092
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
810
1093
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1096
class MandosServer(dbus.service.Object):
1097
"""A D-Bus proxy object"""
1099
dbus.service.Object.__init__(self, bus,
1101
_interface = u"org.mandos_system.Mandos"
1103
@dbus.service.signal(_interface, signature="oa{sv}")
1104
def ClientAdded(self, objpath, properties):
1108
@dbus.service.signal(_interface, signature="os")
1109
def ClientRemoved(self, objpath, name):
1113
@dbus.service.method(_interface, out_signature="ao")
1114
def GetAllClients(self):
1115
return dbus.Array(c.dbus_object_path for c in clients)
1117
@dbus.service.method(_interface, out_signature="a{oa{sv}}")
1118
def GetAllClientsWithProperties(self):
1119
return dbus.Dictionary(
1120
((c.dbus_object_path, c.GetAllProperties())
1124
@dbus.service.method(_interface, in_signature="o")
1125
def RemoveClient(self, object_path):
1127
if c.dbus_object_path == object_path:
1129
# Don't signal anything except ClientRemoved
1133
self.ClientRemoved(object_path, c.name)
1137
@dbus.service.method(_interface, in_signature="s")
1138
def RemoveClientByName(self, name):
1142
# Don't signal anything except ClientRemoved
1146
self.ClientRemoved(c.dbus_object_path, name)
1150
@dbus.service.method(_interface)
1156
mandos_server = MandosServer()
812
1158
for client in clients:
815
tcp_server = IPv6_TCPServer((server_settings["address"],
816
server_settings["port"]),
818
settings=server_settings,
1161
mandos_server.ClientAdded(client.dbus_object_path,
1162
client.GetAllProperties())
1166
tcp_server.server_activate()
820
1168
# Find out what port we got
821
1169
service.port = tcp_server.socket.getsockname()[1]
822
1170
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"