57
57
import logging.handlers
59
from contextlib import closing
65
62
from dbus.mainloop.glib import DBusGMainLoop
65
# Brief description of the operation of this program:
67
# This server announces itself as a Zeroconf service. Connecting
68
# clients use the TLS protocol, with the unusual quirk that this
69
# server program acts as a TLS "client" while the connecting clients
70
# acts as a TLS "server". The clients (acting as a TLS "server") must
71
# supply an OpenPGP certificate, and the fingerprint of this
72
# certificate is used by this server to look up (in a list read from a
73
# file at start time) which binary blob to give the client. No other
74
# authentication or authorization is done by this server.
71
77
logger = logging.Logger('mandos')
72
syslogger = (logging.handlers.SysLogHandler
73
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
74
address = "/dev/log"))
75
syslogger.setFormatter(logging.Formatter
76
('Mandos: %(levelname)s: %(message)s'))
78
syslogger = logging.handlers.SysLogHandler\
79
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
80
syslogger.setFormatter(logging.Formatter\
81
('%(levelname)s: %(message)s'))
77
82
logger.addHandler(syslogger)
79
console = logging.StreamHandler()
80
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
82
logger.addHandler(console)
84
class AvahiError(Exception):
85
def __init__(self, value):
87
super(AvahiError, self).__init__()
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
servicetype = None, port = None, TXT = None,
116
domain = "", host = "", max_renames = 32768):
117
self.interface = interface
119
self.type = servicetype
121
self.TXT = TXT if TXT is not None else []
124
self.rename_count = 0
125
self.max_renames = max_renames
127
"""Derived from the Avahi example code"""
128
if self.rename_count >= self.max_renames:
129
logger.critical(u"No suitable Zeroconf service name found"
130
u" after %i retries, exiting.",
132
raise AvahiServiceError("Too many renames")
133
self.name = server.GetAlternativeServiceName(self.name)
134
logger.info(u"Changing Zeroconf service name to %r ...",
136
syslogger.setFormatter(logging.Formatter
137
('Mandos (%s): %%(levelname)s:'
138
' %%(message)s' % self.name))
141
self.rename_count += 1
143
"""Derived from the Avahi example code"""
144
if group is not None:
147
"""Derived from the Avahi example code"""
150
group = dbus.Interface(bus.get_object
152
server.EntryGroupNew()),
153
avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
group.connect_to_signal('StateChanged',
155
entry_group_state_changed)
156
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
157
service.name, service.type)
159
self.interface, # interface
160
avahi.PROTO_INET6, # protocol
161
dbus.UInt32(0), # flags
162
self.name, self.type,
163
self.domain, self.host,
164
dbus.UInt16(self.port),
165
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
168
89
# From the Avahi example code:
169
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
170
99
# End of Avahi example code
173
def _datetime_to_dbus_struct(dt, variant_level=0):
174
"""Convert a UTC datetime.datetime() to a D-Bus struct.
175
The format is special to this application, since we could not find
176
any other standard way."""
177
return dbus.Struct((dbus.Int16(dt.year),
181
dbus.Byte(dt.minute),
182
dbus.Byte(dt.second),
183
dbus.UInt32(dt.microsecond)),
185
variant_level=variant_level)
188
class Client(dbus.service.Object):
102
class Client(object):
189
103
"""A representation of a client host served by this server.
191
name: string; from the config file, used in log messages
105
name: string; from the config file, used in log messages
192
106
fingerprint: string (40 or 32 hexadecimal digits); used to
193
107
uniquely identify the client
194
secret: bytestring; sent verbatim (over TLS) to client
195
host: string; available for use by the checker command
196
created: datetime.datetime(); (UTC) object creation
197
last_started: datetime.datetime(); (UTC)
199
last_checked_ok: datetime.datetime(); (UTC) or None
200
timeout: datetime.timedelta(); How long from last_checked_ok
201
until this client is invalid
202
interval: datetime.timedelta(); How often to start a new checker
203
stop_hook: If set, called by stop() as stop_hook(self)
204
checker: subprocess.Popen(); a running checker process used
205
to see if the client lives.
206
'None' if no process is running.
108
secret: bytestring; sent verbatim (over TLS) to client
109
fqdn: string (FQDN); available for use by the checker command
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
114
interval: datetime.timedelta(); How often to start a new checker
115
stop_hook: If set, called by stop() as stop_hook(self)
116
checker: subprocess.Popen(); a running checker process used
117
to see if the client lives.
118
Is None if no process is running.
207
119
checker_initiator_tag: a gobject event source tag, or None
208
120
stop_initiator_tag: - '' -
209
121
checker_callback_tag: - '' -
210
122
checker_command: string; External command which is run to check if
211
client lives. %() expansions are done at
123
client lives. %()s expansions are done at
212
124
runtime with vars(self) as dict, so that for
213
125
instance %(name)s can be used in the command.
214
dbus_object_path: dbus.ObjectPath
215
126
Private attibutes:
216
127
_timeout: Real variable for 'timeout'
217
128
_interval: Real variable for 'interval'
218
_timeout_milliseconds: Used when calling gobject.timeout_add()
129
_timeout_milliseconds: Used by gobject.timeout_add()
219
130
_interval_milliseconds: - '' -
221
132
def _set_timeout(self, timeout):
222
"Setter function for the 'timeout' attribute"
133
"Setter function for 'timeout' attribute"
223
134
self._timeout = timeout
224
135
self._timeout_milliseconds = ((self.timeout.days
225
136
* 24 * 60 * 60 * 1000)
226
137
+ (self.timeout.seconds * 1000)
227
138
+ (self.timeout.microseconds
230
self.PropertyChanged(dbus.String(u"timeout"),
231
(dbus.UInt64(self._timeout_milliseconds,
233
timeout = property(lambda self: self._timeout, _set_timeout)
140
timeout = property(lambda self: self._timeout,
236
143
def _set_interval(self, interval):
237
"Setter function for the 'interval' attribute"
144
"Setter function for 'interval' attribute"
238
145
self._interval = interval
239
146
self._interval_milliseconds = ((self.interval.days
240
147
* 24 * 60 * 60 * 1000)
243
150
+ (self.interval.microseconds
246
self.PropertyChanged(dbus.String(u"interval"),
247
(dbus.UInt64(self._interval_milliseconds,
249
interval = property(lambda self: self._interval, _set_interval)
152
interval = property(lambda self: self._interval,
250
154
del _set_interval
252
def __init__(self, name = None, stop_hook=None, config=None):
253
"""Note: the 'checker' key in 'config' sets the
254
'checker_command' attribute and *not* the 'checker'
256
self.dbus_object_path = (dbus.ObjectPath
258
+ name.replace(".", "_")))
259
dbus.service.Object.__init__(self, bus,
260
self.dbus_object_path)
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.."""
264
161
logger.debug(u"Creating client %r", self.name)
265
# Uppercase and remove spaces from fingerprint for later
266
# comparison purposes with return value from the fingerprint()
268
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"")
270
166
logger.debug(u" Fingerprint: %s", self.fingerprint)
271
if "secret" in config:
272
self.secret = config["secret"].decode(u"base64")
273
elif "secfile" in config:
274
with closing(open(os.path.expanduser
276
(config["secfile"])))) as secfile:
277
self.secret = secfile.read()
168
self.secret = secret.decode(u"base64")
171
self.secret = sf.read()
279
raise TypeError(u"No secret or secfile for client %s"
281
self.host = config.get("host", "")
282
self.created = datetime.datetime.utcnow()
284
self.last_started = None
285
self.last_checked_ok = None
286
self.timeout = string_to_delta(config["timeout"])
287
self.interval = string_to_delta(config["interval"])
174
raise RuntimeError(u"No secret or secfile for client %s"
176
self.fqdn = fqdn # string
177
self.created = datetime.datetime.now()
178
self.last_seen = None
179
self.timeout = string_to_delta(timeout)
180
self.interval = string_to_delta(interval)
288
181
self.stop_hook = stop_hook
289
182
self.checker = None
290
183
self.checker_initiator_tag = None
291
184
self.stop_initiator_tag = None
292
185
self.checker_callback_tag = None
293
self.checker_command = config["checker"]
186
self.check_command = checker
296
188
"""Start this client's checker and timeout hooks"""
297
self.last_started = datetime.datetime.utcnow()
298
189
# Schedule a new checker to be started an 'interval' from now,
299
190
# and every interval from then on.
300
self.checker_initiator_tag = (gobject.timeout_add
301
(self._interval_milliseconds,
191
self.checker_initiator_tag = gobject.timeout_add\
192
(self._interval_milliseconds,
303
194
# Also start a new checker *right now*.
304
195
self.start_checker()
305
196
# Schedule a stop() when 'timeout' has passed
306
self.stop_initiator_tag = (gobject.timeout_add
307
(self._timeout_milliseconds,
311
self.PropertyChanged(dbus.String(u"started"),
312
dbus.Boolean(True, variant_level=1))
313
self.PropertyChanged(dbus.String(u"last_started"),
314
(_datetime_to_dbus_struct
315
(self.last_started, variant_level=1)))
197
self.stop_initiator_tag = gobject.timeout_add\
198
(self._timeout_milliseconds,
318
"""Stop this client."""
319
if not getattr(self, "started", False):
202
The possibility that this client might be restarted is left
203
open, but not currently used."""
204
# If this client doesn't have a secret, it is already stopped.
206
logger.debug(u"Stopping client %s", self.name)
321
logger.info(u"Stopping client %s", self.name)
322
if getattr(self, "stop_initiator_tag", False):
210
if hasattr(self, "stop_initiator_tag") \
211
and self.stop_initiator_tag:
323
212
gobject.source_remove(self.stop_initiator_tag)
324
213
self.stop_initiator_tag = None
325
if getattr(self, "checker_initiator_tag", False):
214
if hasattr(self, "checker_initiator_tag") \
215
and self.checker_initiator_tag:
326
216
gobject.source_remove(self.checker_initiator_tag)
327
217
self.checker_initiator_tag = None
328
218
self.stop_checker()
329
219
if self.stop_hook:
330
220
self.stop_hook(self)
333
self.PropertyChanged(dbus.String(u"started"),
334
dbus.Boolean(False, variant_level=1))
335
221
# Do not run this again if called by a gobject.timeout_add
338
223
def __del__(self):
339
224
self.stop_hook = None
342
def checker_callback(self, pid, condition, command):
226
def checker_callback(self, pid, condition):
343
227
"""The checker has completed, so take appropriate actions."""
228
now = datetime.datetime.now()
344
229
self.checker_callback_tag = None
345
230
self.checker = None
347
self.PropertyChanged(dbus.String(u"checker_running"),
348
dbus.Boolean(False, variant_level=1))
349
if (os.WIFEXITED(condition)
350
and (os.WEXITSTATUS(condition) == 0)):
351
logger.info(u"Checker for %(name)s succeeded",
354
self.CheckerCompleted(dbus.Boolean(True),
355
dbus.UInt16(condition),
356
dbus.String(command))
231
if os.WIFEXITED(condition) \
232
and (os.WEXITSTATUS(condition) == 0):
233
logger.debug(u"Checker for %(name)s succeeded",
236
gobject.source_remove(self.stop_initiator_tag)
237
self.stop_initiator_tag = gobject.timeout_add\
238
(self._timeout_milliseconds,
358
240
elif not os.WIFEXITED(condition):
359
241
logger.warning(u"Checker for %(name)s crashed?",
362
self.CheckerCompleted(dbus.Boolean(False),
363
dbus.UInt16(condition),
364
dbus.String(command))
366
logger.info(u"Checker for %(name)s failed",
369
self.CheckerCompleted(dbus.Boolean(False),
370
dbus.UInt16(condition),
371
dbus.String(command))
373
def bump_timeout(self):
374
"""Bump up the timeout for this client.
375
This should only be called when the client has been seen,
378
self.last_checked_ok = datetime.datetime.utcnow()
379
gobject.source_remove(self.stop_initiator_tag)
380
self.stop_initiator_tag = (gobject.timeout_add
381
(self._timeout_milliseconds,
383
self.PropertyChanged(dbus.String(u"last_checked_ok"),
384
(_datetime_to_dbus_struct
385
(self.last_checked_ok,
244
logger.debug(u"Checker for %(name)s failed",
388
246
def start_checker(self):
389
247
"""Start a new checker subprocess if one is not running.
390
248
If a checker already exists, leave it running and do
399
257
# is as it should be.
400
258
if self.checker is None:
402
# In case checker_command has exactly one % operator
403
command = self.checker_command % self.host
260
command = self.check_command % self.fqdn
404
261
except TypeError:
405
# Escape attributes for the shell
406
262
escaped_attrs = dict((key, re.escape(str(val)))
408
264
vars(self).iteritems())
410
command = self.checker_command % escaped_attrs
266
command = self.check_command % escaped_attrs
411
267
except TypeError, error:
412
logger.error(u'Could not format string "%s":'
413
u' %s', self.checker_command, error)
268
logger.critical(u'Could not format string "%s":'
269
u' %s', self.check_command, error)
414
270
return True # Try again later
416
logger.info(u"Starting checker %r for %s",
418
# We don't need to redirect stdout and stderr, since
419
# in normal mode, that is already done by daemon(),
420
# and in debug mode we don't want to. (Stdin is
421
# always replaced by /dev/null.)
422
self.checker = subprocess.Popen(command,
426
self.CheckerStarted(command)
427
self.PropertyChanged(dbus.String("checker_running"),
428
dbus.Boolean(True, variant_level=1))
429
self.checker_callback_tag = (gobject.child_watch_add
431
self.checker_callback,
433
except OSError, error:
272
logger.debug(u"Starting checker %r for %s",
274
self.checker = subprocess.\
276
close_fds=True, shell=True,
278
self.checker_callback_tag = gobject.child_watch_add\
280
self.checker_callback)
281
except subprocess.OSError, error:
434
282
logger.error(u"Failed to start subprocess: %s",
436
284
# Re-run this periodically if run by gobject.timeout_add
439
286
def stop_checker(self):
440
287
"""Force the checker process, if any, to stop."""
441
288
if self.checker_callback_tag:
442
289
gobject.source_remove(self.checker_callback_tag)
443
290
self.checker_callback_tag = None
444
if getattr(self, "checker", None) is None:
291
if not hasattr(self, "checker") or self.checker is None:
446
logger.debug(u"Stopping checker for %(name)s", vars(self))
293
logger.debug("Stopping checker for %(name)s", vars(self))
448
295
os.kill(self.checker.pid, signal.SIGTERM)
450
297
#if self.checker.poll() is None:
451
298
# os.kill(self.checker.pid, signal.SIGKILL)
452
299
except OSError, error:
453
if error.errno != errno.ESRCH: # No such process
300
if error.errno != errno.ESRCH:
455
302
self.checker = None
456
self.PropertyChanged(dbus.String(u"checker_running"),
457
dbus.Boolean(False, variant_level=1))
459
def still_valid(self):
303
def still_valid(self, now=None):
460
304
"""Has the timeout not yet passed for this client?"""
461
if not getattr(self, "started", False):
463
now = datetime.datetime.utcnow()
464
if self.last_checked_ok is None:
306
now = datetime.datetime.now()
307
if self.last_seen is None:
465
308
return now < (self.created + self.timeout)
467
return now < (self.last_checked_ok + self.timeout)
469
## D-Bus methods & signals
470
_interface = u"org.mandos_system.Mandos.Client"
472
# BumpTimeout - method
473
BumpTimeout = dbus.service.method(_interface)(bump_timeout)
474
BumpTimeout.__name__ = "BumpTimeout"
476
# CheckerCompleted - signal
477
@dbus.service.signal(_interface, signature="bqs")
478
def CheckerCompleted(self, success, condition, command):
482
# CheckerStarted - signal
483
@dbus.service.signal(_interface, signature="s")
484
def CheckerStarted(self, command):
488
# GetAllProperties - method
489
@dbus.service.method(_interface, out_signature="a{sv}")
490
def GetAllProperties(self):
492
return dbus.Dictionary({
494
dbus.String(self.name, variant_level=1),
495
dbus.String("fingerprint"):
496
dbus.String(self.fingerprint, variant_level=1),
498
dbus.String(self.host, variant_level=1),
499
dbus.String("created"):
500
_datetime_to_dbus_struct(self.created,
502
dbus.String("last_started"):
503
(_datetime_to_dbus_struct(self.last_started,
505
if self.last_started is not None
506
else dbus.Boolean(False, variant_level=1)),
507
dbus.String("started"):
508
dbus.Boolean(self.started, variant_level=1),
509
dbus.String("last_checked_ok"):
510
(_datetime_to_dbus_struct(self.last_checked_ok,
512
if self.last_checked_ok is not None
513
else dbus.Boolean (False, variant_level=1)),
514
dbus.String("timeout"):
515
dbus.UInt64(self._timeout_milliseconds,
517
dbus.String("interval"):
518
dbus.UInt64(self._interval_milliseconds,
520
dbus.String("checker"):
521
dbus.String(self.checker_command,
523
dbus.String("checker_running"):
524
dbus.Boolean(self.checker is not None,
528
# IsStillValid - method
529
IsStillValid = (dbus.service.method(_interface, out_signature="b")
531
IsStillValid.__name__ = "IsStillValid"
533
# PropertyChanged - signal
534
@dbus.service.signal(_interface, signature="sv")
535
def PropertyChanged(self, property, value):
539
# SetChecker - method
540
@dbus.service.method(_interface, in_signature="s")
541
def SetChecker(self, checker):
542
"D-Bus setter method"
543
self.checker_command = checker
546
@dbus.service.method(_interface, in_signature="s")
547
def SetHost(self, host):
548
"D-Bus setter method"
551
# SetInterval - method
552
@dbus.service.method(_interface, in_signature="t")
553
def SetInterval(self, milliseconds):
554
self.interval = datetime.timdeelta(0, 0, 0, milliseconds)
557
@dbus.service.method(_interface, in_signature="ay",
559
def SetSecret(self, secret):
560
"D-Bus setter method"
561
self.secret = str(secret)
563
# SetTimeout - method
564
@dbus.service.method(_interface, in_signature="t")
565
def SetTimeout(self, milliseconds):
566
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
569
Start = dbus.service.method(_interface)(start)
570
Start.__name__ = "Start"
572
# StartChecker - method
573
@dbus.service.method(_interface)
574
def StartChecker(self):
579
@dbus.service.method(_interface)
584
# StopChecker - method
585
StopChecker = dbus.service.method(_interface)(stop_checker)
586
StopChecker.__name__ = "StopChecker"
310
return now < (self.last_seen + self.timeout)
591
313
def peer_certificate(session):
592
314
"Return the peer's OpenPGP certificate as a bytestring"
593
315
# If not an OpenPGP certificate...
594
if (gnutls.library.functions
595
.gnutls_certificate_type_get(session._c_object)
596
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
316
if gnutls.library.functions.gnutls_certificate_type_get\
317
(session._c_object) \
318
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
597
319
# ...do the normal thing
598
320
return session.peer_certificate
599
321
list_size = ctypes.c_uint()
600
cert_list = (gnutls.library.functions
601
.gnutls_certificate_get_peers
602
(session._c_object, ctypes.byref(list_size)))
322
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
323
(session._c_object, ctypes.byref(list_size))
603
324
if list_size.value == 0:
605
326
cert = cert_list[0]
609
330
def fingerprint(openpgp):
610
331
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
611
# New GnuTLS "datum" with the OpenPGP public key
612
datum = (gnutls.library.types
613
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
616
ctypes.c_uint(len(openpgp))))
617
332
# New empty GnuTLS certificate
618
333
crt = gnutls.library.types.gnutls_openpgp_crt_t()
619
(gnutls.library.functions
620
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
334
gnutls.library.functions.gnutls_openpgp_crt_init\
336
# New GnuTLS "datum" with the OpenPGP public key
337
datum = gnutls.library.types.gnutls_datum_t\
338
(ctypes.cast(ctypes.c_char_p(openpgp),
339
ctypes.POINTER(ctypes.c_ubyte)),
340
ctypes.c_uint(len(openpgp)))
621
341
# Import the OpenPGP public key into the certificate
622
(gnutls.library.functions
623
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
624
gnutls.library.constants
625
.GNUTLS_OPENPGP_FMT_RAW))
626
# Verify the self signature in the key
627
crtverify = ctypes.c_uint()
628
(gnutls.library.functions
629
.gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
630
if crtverify.value != 0:
631
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
632
raise gnutls.errors.CertificateSecurityError("Verify failed")
342
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
345
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
633
346
# New buffer for the fingerprint
634
buf = ctypes.create_string_buffer(20)
635
buf_len = ctypes.c_size_t()
347
buffer = ctypes.create_string_buffer(20)
348
buffer_length = ctypes.c_size_t()
636
349
# Get the fingerprint from the certificate into the buffer
637
(gnutls.library.functions
638
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
639
ctypes.byref(buf_len)))
350
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
351
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
640
352
# Deinit the certificate
641
353
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
642
354
# Convert the buffer to a Python bytestring
643
fpr = ctypes.string_at(buf, buf_len.value)
355
fpr = ctypes.string_at(buffer, buffer_length.value)
644
356
# Convert the bytestring to hexadecimal notation
645
357
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
649
class TCP_handler(SocketServer.BaseRequestHandler, object):
361
class tcp_handler(SocketServer.BaseRequestHandler, object):
650
362
"""A TCP request handler class.
651
363
Instantiated by IPv6_TCPServer for each request to handle it.
652
364
Note: This will run in its own forked process."""
654
366
def handle(self):
655
logger.info(u"TCP connection from: %s",
656
unicode(self.client_address))
657
session = (gnutls.connection
658
.ClientSession(self.request,
662
line = self.request.makefile().readline()
663
logger.debug(u"Protocol version: %r", line)
665
if int(line.strip().split()[0]) > 1:
667
except (ValueError, IndexError, RuntimeError), error:
668
logger.error(u"Unknown protocol version: %s", error)
671
# Note: gnutls.connection.X509Credentials is really a generic
672
# GnuTLS certificate credentials object so long as no X.509
673
# keys are added to it. Therefore, we can use it here despite
674
# using OpenPGP certificates.
367
logger.debug(u"TCP connection from: %s",
368
unicode(self.client_address))
369
session = gnutls.connection.ClientSession(self.request,
676
373
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
677
374
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
679
# Use a fallback default, since this MUST be set.
680
priority = self.server.settings.get("priority", "NORMAL")
681
(gnutls.library.functions
682
.gnutls_priority_set_direct(session._c_object,
377
if self.server.options.priority:
378
priority = self.server.options.priority
379
gnutls.library.functions.gnutls_priority_set_direct\
380
(session._c_object, priority, None);
686
383
session.handshake()
687
384
except gnutls.errors.GNUTLSError, error:
688
logger.warning(u"Handshake failed: %s", error)
385
logger.debug(u"Handshake failed: %s", error)
689
386
# Do not run session.bye() here: the session is not
690
387
# established. Just abandon the request.
693
390
fpr = fingerprint(peer_certificate(session))
694
391
except (TypeError, gnutls.errors.GNUTLSError), error:
695
logger.warning(u"Bad certificate: %s", error)
392
logger.debug(u"Bad certificate: %s", error)
698
395
logger.debug(u"Fingerprint: %s", fpr)
699
397
for c in self.server.clients:
700
398
if c.fingerprint == fpr:
704
logger.warning(u"Client not found for fingerprint: %s",
708
401
# Have to check if client.still_valid(), since it is possible
709
402
# that the client timed out while establishing the GnuTLS
711
if not client.still_valid():
712
logger.warning(u"Client %(name)s is invalid",
404
if (not client) or (not client.still_valid()):
406
logger.debug(u"Client %(name)s is invalid",
409
logger.debug(u"Client not found for fingerprint: %s",
716
## This won't work here, since we're in a fork.
717
# client.bump_timeout()
719
414
while sent_size < len(client.secret):
720
415
sent = session.send(client.secret[sent_size:])
728
class IPv6_TCPServer(SocketServer.ForkingMixIn,
729
SocketServer.TCPServer, object):
423
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
730
424
"""IPv6 TCP server. Accepts 'None' as address and/or port.
732
settings: Server settings
426
options: Command line options
733
427
clients: Set() of Client objects
734
enabled: Boolean; whether this server is activated yet
736
429
address_family = socket.AF_INET6
737
430
def __init__(self, *args, **kwargs):
738
if "settings" in kwargs:
739
self.settings = kwargs["settings"]
740
del kwargs["settings"]
431
if "options" in kwargs:
432
self.options = kwargs["options"]
433
del kwargs["options"]
741
434
if "clients" in kwargs:
742
435
self.clients = kwargs["clients"]
743
436
del kwargs["clients"]
745
super(IPv6_TCPServer, self).__init__(*args, **kwargs)
437
return super(type(self), self).__init__(*args, **kwargs)
746
438
def server_bind(self):
747
439
"""This overrides the normal server_bind() function
748
440
to bind to an interface if one was specified, and also NOT to
749
441
bind to an address or port if they were not specified."""
750
if self.settings["interface"]:
751
# 25 is from /usr/include/asm-i486/socket.h
752
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
754
447
self.socket.setsockopt(socket.SOL_SOCKET,
756
self.settings["interface"])
448
socket.SO_BINDTODEVICE,
449
self.options.interface)
757
450
except socket.error, error:
758
451
if error[0] == errno.EPERM:
759
logger.error(u"No permission to"
760
u" bind to interface %s",
761
self.settings["interface"])
452
logger.warning(u"No permission to"
453
u" bind to interface %s",
454
self.options.interface)
764
457
# Only bind(2) the socket if we really need to.
798
479
datetime.timedelta(1)
799
480
>>> string_to_delta(u'1w')
800
481
datetime.timedelta(7)
801
>>> string_to_delta('5m 30s')
802
datetime.timedelta(0, 330)
804
timevalue = datetime.timedelta(0)
805
for s in interval.split():
807
suffix = unicode(s[-1])
810
delta = datetime.timedelta(value)
812
delta = datetime.timedelta(0, value)
814
delta = datetime.timedelta(0, 0, 0, 0, value)
816
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
818
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
821
except (ValueError, IndexError):
484
suffix=unicode(interval[-1])
485
value=int(interval[:-1])
487
delta = datetime.timedelta(value)
489
delta = datetime.timedelta(0, value)
491
delta = datetime.timedelta(0, 0, 0, 0, value)
493
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
495
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
498
except (ValueError, IndexError):
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:
827
536
def server_state_changed(state):
828
537
"""Derived from the Avahi example code"""
829
538
if state == avahi.SERVER_COLLISION:
830
logger.error(u"Zeroconf server name collision")
539
logger.warning(u"Server name collision")
832
541
elif state == avahi.SERVER_RUNNING:
836
545
def entry_group_state_changed(state, error):
837
546
"""Derived from the Avahi example code"""
838
logger.debug(u"Avahi state change: %i", state)
547
global serviceName, server, rename_count
549
logger.debug(u"state change: %i", state)
840
551
if state == avahi.ENTRY_GROUP_ESTABLISHED:
841
logger.debug(u"Zeroconf service established.")
552
logger.debug(u"Service established.")
842
553
elif state == avahi.ENTRY_GROUP_COLLISION:
843
logger.warning(u"Zeroconf 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)
845
567
elif state == avahi.ENTRY_GROUP_FAILURE:
846
logger.critical(u"Avahi: Error in group state changed %s",
848
raise AvahiGroupError("State changed: %s", str(error))
568
logger.error(u"Error in group state changed %s",
850
573
def if_nametoindex(interface):
851
"""Call the C function if_nametoindex(), or equivalent"""
852
global if_nametoindex
574
"""Call the C function if_nametoindex()"""
854
if_nametoindex = (ctypes.cdll.LoadLibrary
855
(ctypes.util.find_library("c"))
576
libc = ctypes.cdll.LoadLibrary("libc.so.6")
577
return libc.if_nametoindex(interface)
857
578
except (OSError, AttributeError):
858
579
if "struct" not in sys.modules:
860
581
if "fcntl" not in sys.modules:
862
def if_nametoindex(interface):
863
"Get an interface index the hard way, i.e. using fcntl()"
864
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
865
with closing(socket.socket()) as s:
866
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
867
struct.pack("16s16x", interface))
868
interface_index = struct.unpack("I", ifreq[16:20])[0]
869
return interface_index
870
return if_nametoindex(interface)
873
def daemon(nochdir = False, noclose = False):
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
592
def daemon(nochdir, noclose):
874
593
"""See daemon(3). Standard BSD Unix function.
875
594
This should really exist as os.daemon, but it doesn't (yet)."""
613
def killme(status = 0):
614
logger.debug("Stopping server with exit status %d", status)
616
if main_loop_started:
897
parser = OptionParser(version = "%%prog %s" % version)
625
global main_loop_started
626
main_loop_started = False
628
parser = OptionParser()
898
629
parser.add_option("-i", "--interface", type="string",
899
metavar="IF", help="Bind to interface IF")
900
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,
901
633
help="Address to listen for requests on")
902
parser.add_option("-p", "--port", type="int",
634
parser.add_option("-p", "--port", type="int", default=None,
903
635
help="Port number to receive requests on")
904
636
parser.add_option("--check", action="store_true", default=False,
905
637
help="Run self-test")
906
parser.add_option("--debug", action="store_true",
907
help="Debug mode; run in foreground and log to"
909
parser.add_option("--priority", type="string", help="GnuTLS"
910
" priority string (see GnuTLS documentation)")
911
parser.add_option("--servicename", type="string", metavar="NAME",
912
help="Zeroconf service name")
913
parser.add_option("--configdir", type="string",
914
default="/etc/mandos", metavar="DIR",
915
help="Directory to search for configuration"
917
options = parser.parse_args()[0]
638
parser.add_option("--debug", action="store_true", default=False,
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")
646
(options, args) = parser.parse_args()
919
648
if options.check:
921
650
doctest.testmod()
924
# Default values for config file for server-global settings
925
server_defaults = { "interface": "",
930
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
931
"servicename": "Mandos",
934
# Parse config file for server-global settings
935
server_config = ConfigParser.SafeConfigParser(server_defaults)
937
server_config.read(os.path.join(options.configdir, "mandos.conf"))
938
# Convert the SafeConfigParser object to a dict
939
server_settings = server_config.defaults()
940
# Use getboolean on the boolean config option
941
server_settings["debug"] = (server_config.getboolean
942
("DEFAULT", "debug"))
945
# Override the settings from the config file with command line
947
for option in ("interface", "address", "port", "debug",
948
"priority", "servicename", "configdir"):
949
value = getattr(options, option)
950
if value is not None:
951
server_settings[option] = value
953
# Now we have our good server settings in "server_settings"
955
debug = server_settings["debug"]
958
syslogger.setLevel(logging.WARNING)
959
console.setLevel(logging.WARNING)
961
if server_settings["servicename"] != "Mandos":
962
syslogger.setFormatter(logging.Formatter
963
('Mandos (%s): %%(levelname)s:'
965
% server_settings["servicename"]))
967
# Parse config file with clients
968
client_defaults = { "timeout": "1h",
970
"checker": "fping -q -- %(host)s",
973
client_config = ConfigParser.SafeConfigParser(client_defaults)
974
client_config.read(os.path.join(server_settings["configdir"],
978
tcp_server = IPv6_TCPServer((server_settings["address"],
979
server_settings["port"]),
981
settings=server_settings,
983
pidfilename = "/var/run/mandos.pid"
985
pidfile = open(pidfilename, "w")
986
except IOError, error:
987
logger.error("Could not open file %r", pidfilename)
990
uid = pwd.getpwnam("_mandos").pw_uid
993
uid = pwd.getpwnam("mandos").pw_uid
996
uid = pwd.getpwnam("nobody").pw_uid
1000
gid = pwd.getpwnam("_mandos").pw_gid
1003
gid = pwd.getpwnam("mandos").pw_gid
1006
gid = pwd.getpwnam("nogroup").pw_gid
1012
except OSError, error:
1013
if error[0] != errno.EPERM:
1017
service = AvahiService(name = server_settings["servicename"],
1018
servicetype = "_mandos._tcp", )
1019
if server_settings["interface"]:
1020
service.interface = (if_nametoindex
1021
(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;
1023
665
global main_loop
1027
669
DBusGMainLoop(set_as_default=True )
1028
670
main_loop = gobject.MainLoop()
1029
671
bus = dbus.SystemBus()
1030
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1031
avahi.DBUS_PATH_SERVER),
1032
avahi.DBUS_INTERFACE_SERVER)
672
server = dbus.Interface(
673
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
674
avahi.DBUS_INTERFACE_SERVER )
1033
675
# End of Avahi example code
1034
bus_name = dbus.service.BusName(u"org.mandos-system.Mandos", bus)
1036
clients.update(Set(Client(name = section,
1038
= dict(client_config.items(section)))
677
debug = options.debug
680
console = logging.StreamHandler()
681
# console.setLevel(logging.DEBUG)
682
console.setFormatter(logging.Formatter\
683
('%(levelname)s: %(message)s'))
684
logger.addHandler(console)
688
def remove_from_clients(client):
689
clients.remove(client)
691
logger.debug(u"No clients left, exiting")
694
clients.update(Set(Client(name=section,
695
stop_hook = remove_from_clients,
696
**(dict(client_config\
1039
698
for section in client_config.sections()))
1041
logger.critical(u"No clients defined")
1045
# Redirect stdin so all checkers get /dev/null
1046
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1047
os.dup2(null, sys.stdin.fileno())
1051
# No console logging
1052
logger.removeHandler(console)
1053
# Close all input and output, do double fork, etc.
1058
pidfile.write(str(pid) + "\n")
1062
logger.error(u"Could not write to file %r with PID %d",
1065
# "pidfile" was never created
1070
704
"Cleanup function; run on exit"
1086
720
signal.signal(signal.SIGINT, signal.SIG_IGN)
1087
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1088
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1090
class MandosServer(dbus.service.Object):
1091
"""A D-Bus proxy object"""
1093
dbus.service.Object.__init__(self, bus,
1095
_interface = u"org.mandos_system.Mandos"
1097
@dbus.service.signal(_interface, signature="oa{sv}")
1098
def ClientAdded(self, objpath, properties):
1102
@dbus.service.signal(_interface, signature="o")
1103
def ClientRemoved(self, objpath):
1107
@dbus.service.method(_interface, out_signature="ao")
1108
def GetAllClients(self):
1109
return dbus.Array(c.dbus_object_path for c in clients)
1111
@dbus.service.method(_interface, out_signature="a{oa{sv}}")
1112
def GetAllClientsWithProperties(self):
1113
return dbus.Dictionary(
1114
((c.dbus_object_path, c.GetAllProperties())
1118
@dbus.service.method(_interface, in_signature="o")
1119
def RemoveClient(self, object_path):
1121
if c.dbus_object_path == object_path:
1129
mandos_server = MandosServer()
721
signal.signal(signal.SIGHUP, lambda signum, frame: killme())
722
signal.signal(signal.SIGTERM, lambda signum, frame: killme())
1131
724
for client in clients:
1133
mandos_server.ClientAdded(client.dbus_object_path,
1134
client.GetAllProperties())
1138
tcp_server.server_activate()
1140
# Find out what port we got
1141
service.port = tcp_server.socket.getsockname()[1]
1142
logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
1143
u" scope_id %d" % tcp_server.socket.getsockname())
1145
#service.interface = tcp_server.socket.getsockname()[3]
1148
# From the Avahi example code
1149
server.connect_to_signal("StateChanged", server_state_changed)
1151
server_state_changed(server.GetState())
1152
except dbus.exceptions.DBusException, error:
1153
logger.critical(u"DBusException: %s", error)
1155
# End of Avahi example code
1157
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1158
lambda *args, **kwargs:
1159
(tcp_server.handle_request
1160
(*args[2:], **kwargs) or True))
1162
logger.debug(u"Starting main loop")
727
tcp_server = IPv6_TCPServer((options.address, options.port),
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:],
754
logger.debug("Starting main loop")
755
main_loop_started = True
1164
except AvahiError, error:
1165
logger.critical(u"AvahiError: %s" + unicode(error))
1167
757
except KeyboardInterrupt:
1171
763
if __name__ == '__main__':