To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to server.py
- browse files at revision 41
- compare with another revision
- download diff
- download tarball
- view history from revision 41
- Committer: Teddy Hogeborn
- Date: 2008-08-03 21:45:14 UTC
- mfrom: (24.1.13 mandos)
- Revision ID: teddy@fukt.bsnet.se-20080803214514-plvvkrpoitwsrxeg
Merge.
- files added:
- ca.pem
- files removed:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- network-hooks.d
- files renamed:
- plugin-runner.c => plugbasedclient.c
- plugins.d/mandos-client.c => plugins.d/mandosclient.c
- plugins.d/password-prompt.c => plugins.d/passprompt.c
- mandos.conf => server.conf
- mandos => server.py
- files modified:
- Makefile
added
removed
server.py
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
# methods "add", "remove", "server_state_changed",
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
# "AvahiService" class, and some lines in "main".
9
# following functions: "AvahiService.add", "AvahiService.remove",
10
# "server_state_changed", "entry_group_state_changed", and some lines
11
# in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
16
15
#
17
16
# This program is free software: you can redistribute it and/or modify
18
17
# it under the terms of the GNU General Public License as published by
25
24
# GNU General Public License for more details.
26
25
#
27
26
# You should have received a copy of the GNU General Public License
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
#
31
# Contact the authors at <mandos@recompile.se>.
32
#
33
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
38
39
import SocketServer as socketserver
27
# along with this program. If not, see <http://www.gnu.org/licenses/>.
28
#
29
# Contact the authors at <mandos@fukt.bsnet.se>.
30
#
31
32
from __future__ import division
33
34
import SocketServer
40
35
import socket
41
import argparse
36
import select
37
from optparse import OptionParser
42
38
import datetime
43
39
import errno
44
40
import gnutls.crypto
47
43
import gnutls.library.functions
48
44
import gnutls.library.constants
49
45
import gnutls.library.types
50
import ConfigParser as configparser
46
import ConfigParser
51
47
import sys
52
48
import re
53
49
import os
54
50
import signal
51
from sets import Set
55
52
import subprocess
56
53
import atexit
57
54
import stat
58
55
import logging
59
56
import logging.handlers
60
import pwd
61
import contextlib
62
import struct
63
import fcntl
64
import functools
65
import cPickle as pickle
66
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
57
72
58
import dbus
73
import dbus.service
74
59
import gobject
75
60
import avahi
76
61
from dbus.mainloop.glib import DBusGMainLoop
77
62
import ctypes
78
import ctypes.util
79
import xml.dom.minidom
80
import inspect
81
import GnuPGInterface
82
83
try:
84
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
except AttributeError:
86
try:
87
from IN import SO_BINDTODEVICE
88
except ImportError:
89
SO_BINDTODEVICE = None
90
91
version = "1.5.4"
92
stored_state_file = "clients.pickle"
93
94
logger = logging.getLogger()
95
syslogger = (logging.handlers.SysLogHandler
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
address = str("/dev/log")))
98
99
try:
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
102
.if_nametoindex)
103
except (OSError, AttributeError):
104
def if_nametoindex(interface):
105
"Get an interface index the hard way, i.e. using fcntl()"
106
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
107
with contextlib.closing(socket.socket()) as s:
108
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
struct.pack(str("16s16x"),
110
interface))
111
interface_index = struct.unpack(str("I"),
112
ifreq[16:20])[0]
113
return interface_index
114
115
116
def initlogger(debug, level=logging.WARNING):
117
"""init logger and add loglevel"""
118
119
syslogger.setFormatter(logging.Formatter
120
('Mandos [%(process)d]: %(levelname)s:'
121
' %(message)s'))
122
logger.addHandler(syslogger)
123
124
if debug:
125
console = logging.StreamHandler()
126
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
127
' [%(process)d]:'
128
' %(levelname)s:'
129
' %(message)s'))
130
logger.addHandler(console)
131
logger.setLevel(level)
132
133
134
class PGPError(Exception):
135
"""Exception if encryption/decryption fails"""
136
pass
137
138
139
class PGPEngine(object):
140
"""A simple class for OpenPGP symmetric encryption & decryption"""
141
def __init__(self):
142
self.gnupg = GnuPGInterface.GnuPG()
143
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
144
self.gnupg = GnuPGInterface.GnuPG()
145
self.gnupg.options.meta_interactive = False
146
self.gnupg.options.homedir = self.tempdir
147
self.gnupg.options.extra_args.extend(['--force-mdc',
148
'--quiet',
149
'--no-use-agent'])
150
151
def __enter__(self):
152
return self
153
154
def __exit__(self, exc_type, exc_value, traceback):
155
self._cleanup()
156
return False
157
158
def __del__(self):
159
self._cleanup()
160
161
def _cleanup(self):
162
if self.tempdir is not None:
163
# Delete contents of tempdir
164
for root, dirs, files in os.walk(self.tempdir,
165
topdown = False):
166
for filename in files:
167
os.remove(os.path.join(root, filename))
168
for dirname in dirs:
169
os.rmdir(os.path.join(root, dirname))
170
# Remove tempdir
171
os.rmdir(self.tempdir)
172
self.tempdir = None
173
174
def password_encode(self, password):
175
# Passphrase can not be empty and can not contain newlines or
176
# NUL bytes. So we prefix it and hex encode it.
177
return b"mandos" + binascii.hexlify(password)
178
179
def encrypt(self, data, password):
180
self.gnupg.passphrase = self.password_encode(password)
181
with open(os.devnull, "w") as devnull:
182
try:
183
proc = self.gnupg.run(['--symmetric'],
184
create_fhs=['stdin', 'stdout'],
185
attach_fhs={'stderr': devnull})
186
with contextlib.closing(proc.handles['stdin']) as f:
187
f.write(data)
188
with contextlib.closing(proc.handles['stdout']) as f:
189
ciphertext = f.read()
190
proc.wait()
191
except IOError as e:
192
raise PGPError(e)
193
self.gnupg.passphrase = None
194
return ciphertext
195
196
def decrypt(self, data, password):
197
self.gnupg.passphrase = self.password_encode(password)
198
with open(os.devnull, "w") as devnull:
199
try:
200
proc = self.gnupg.run(['--decrypt'],
201
create_fhs=['stdin', 'stdout'],
202
attach_fhs={'stderr': devnull})
203
with contextlib.closing(proc.handles['stdin']) as f:
204
f.write(data)
205
with contextlib.closing(proc.handles['stdout']) as f:
206
decrypted_plaintext = f.read()
207
proc.wait()
208
except IOError as e:
209
raise PGPError(e)
210
self.gnupg.passphrase = None
211
return decrypted_plaintext
63
64
# Brief description of the operation of this program:
65
#
66
# This server announces itself as a Zeroconf service. Connecting
67
# clients use the TLS protocol, with the unusual quirk that this
68
# server program acts as a TLS "client" while a connecting client acts
69
# as a TLS "server". The client (acting as a TLS "server") must
70
# supply an OpenPGP certificate, and the fingerprint of this
71
# certificate is used by this server to look up (in a list read from a
72
# file at start time) which binary blob to give the client. No other
73
# authentication or authorization is done by this server.
74
75
76
logger = logging.Logger('mandos')
77
syslogger = logging.handlers.SysLogHandler\
78
(facility = logging.handlers.SysLogHandler.LOG_DAEMON)
79
syslogger.setFormatter(logging.Formatter\
80
('%(levelname)s: %(message)s'))
81
logger.addHandler(syslogger)
82
del syslogger
212
83
213
84
214
85
class AvahiError(Exception):
215
def __init__(self, value, *args, **kwargs):
86
def __init__(self, value):
216
87
self.value = value
217
super(AvahiError, self).__init__(value, *args, **kwargs)
218
def __unicode__(self):
219
return unicode(repr(self.value))
88
def __str__(self):
89
return repr(self.value)
220
90
221
91
class AvahiServiceError(AvahiError):
222
92
pass
226
96
227
97
228
98
class AvahiService(object):
229
"""An Avahi (Zeroconf) service.
230
231
Attributes:
99
"""
232
100
interface: integer; avahi.IF_UNSPEC or an interface index.
233
101
Used to optionally bind to the specified interface.
234
name: string; Example: 'Mandos'
235
type: string; Example: '_mandos._tcp'.
236
See <http://www.dns-sd.org/ServiceTypes.html>
237
port: integer; what port to announce
238
TXT: list of strings; TXT record for the service
239
domain: string; Domain to publish on, default to .local if empty.
240
host: string; Host to publish records for, default is localhost
241
max_renames: integer; maximum number of renames
242
rename_count: integer; counter so we only rename after collisions
243
a sensible number of times
244
group: D-Bus Entry Group
245
server: D-Bus Server
246
bus: dbus.SystemBus()
102
name = string; Example: "Mandos"
103
type = string; Example: "_mandos._tcp".
104
See <http://www.dns-sd.org/ServiceTypes.html>
105
port = integer; what port to announce
106
TXT = list of strings; TXT record for the service
107
domain = string; Domain to publish on, default to .local if empty.
108
host = string; Host to publish records for, default to localhost
109
if empty.
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
247
113
"""
248
249
114
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
250
servicetype = None, port = None, TXT = None,
251
domain = "", host = "", max_renames = 32768,
252
protocol = avahi.PROTO_UNSPEC, bus = None):
115
type = None, port = None, TXT = None, domain = "",
116
host = "", max_renames = 12):
117
"""An Avahi (Zeroconf) service. """
253
118
self.interface = interface
254
119
self.name = name
255
self.type = servicetype
120
self.type = type
256
121
self.port = port
257
self.TXT = TXT if TXT is not None else []
122
if TXT is None:
123
self.TXT = []
124
else:
125
self.TXT = TXT
258
126
self.domain = domain
259
127
self.host = host
260
128
self.rename_count = 0
261
self.max_renames = max_renames
262
self.protocol = protocol
263
self.group = None # our entry group
264
self.server = None
265
self.bus = bus
266
self.entry_group_state_changed_match = None
267
268
129
def rename(self):
269
130
"""Derived from the Avahi example code"""
270
131
if self.rename_count >= self.max_renames:
271
logger.critical("No suitable Zeroconf service name found"
272
" after %i retries, exiting.",
273
self.rename_count)
132
logger.critical(u"No suitable service name found after %i"
133
u" retries, exiting.", rename_count)
274
134
raise AvahiServiceError("Too many renames")
275
self.name = unicode(self.server
276
.GetAlternativeServiceName(self.name))
277
logger.info("Changing Zeroconf service name to %r ...",
278
self.name)
135
name = server.GetAlternativeServiceName(name)
136
logger.notice(u"Changing name to %r ...", name)
279
137
self.remove()
280
try:
281
self.add()
282
except dbus.exceptions.DBusException as error:
283
logger.critical("D-Bus Exception", exc_info=error)
284
self.cleanup()
285
os._exit(1)
138
self.add()
286
139
self.rename_count += 1
287
288
140
def remove(self):
289
141
"""Derived from the Avahi example code"""
290
if self.entry_group_state_changed_match is not None:
291
self.entry_group_state_changed_match.remove()
292
self.entry_group_state_changed_match = None
293
if self.group is not None:
294
self.group.Reset()
295
142
if group is not None:
143
group.Reset()
296
144
def add(self):
297
145
"""Derived from the Avahi example code"""
298
self.remove()
299
if self.group is None:
300
self.group = dbus.Interface(
301
self.bus.get_object(avahi.DBUS_NAME,
302
self.server.EntryGroupNew()),
303
avahi.DBUS_INTERFACE_ENTRY_GROUP)
304
self.entry_group_state_changed_match = (
305
self.group.connect_to_signal(
306
'StateChanged', self.entry_group_state_changed))
307
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
308
self.name, self.type)
309
self.group.AddService(
310
self.interface,
311
self.protocol,
312
dbus.UInt32(0), # flags
313
self.name, self.type,
314
self.domain, self.host,
315
dbus.UInt16(self.port),
316
avahi.string_array_to_txt_array(self.TXT))
317
self.group.Commit()
318
319
def entry_group_state_changed(self, state, error):
320
"""Derived from the Avahi example code"""
321
logger.debug("Avahi entry group state change: %i", state)
322
323
if state == avahi.ENTRY_GROUP_ESTABLISHED:
324
logger.debug("Zeroconf service established.")
325
elif state == avahi.ENTRY_GROUP_COLLISION:
326
logger.info("Zeroconf service name collision.")
327
self.rename()
328
elif state == avahi.ENTRY_GROUP_FAILURE:
329
logger.critical("Avahi: Error in group state changed %s",
330
unicode(error))
331
raise AvahiGroupError("State changed: {0!s}"
332
.format(error))
333
334
def cleanup(self):
335
"""Derived from the Avahi example code"""
336
if self.group is not None:
337
try:
338
self.group.Free()
339
except (dbus.exceptions.UnknownMethodException,
340
dbus.exceptions.DBusException):
341
pass
342
self.group = None
343
self.remove()
344
345
def server_state_changed(self, state, error=None):
346
"""Derived from the Avahi example code"""
347
logger.debug("Avahi server state change: %i", state)
348
bad_states = { avahi.SERVER_INVALID:
349
"Zeroconf server invalid",
350
avahi.SERVER_REGISTERING: None,
351
avahi.SERVER_COLLISION:
352
"Zeroconf server name collision",
353
avahi.SERVER_FAILURE:
354
"Zeroconf server failure" }
355
if state in bad_states:
356
if bad_states[state] is not None:
357
if error is None:
358
logger.error(bad_states[state])
359
else:
360
logger.error(bad_states[state] + ": %r", error)
361
self.cleanup()
362
elif state == avahi.SERVER_RUNNING:
363
self.add()
364
else:
365
if error is None:
366
logger.debug("Unknown state: %r", state)
367
else:
368
logger.debug("Unknown state: %r: %r", state, error)
369
370
def activate(self):
371
"""Derived from the Avahi example code"""
372
if self.server is None:
373
self.server = dbus.Interface(
374
self.bus.get_object(avahi.DBUS_NAME,
375
avahi.DBUS_PATH_SERVER,
376
follow_name_owner_changes=True),
377
avahi.DBUS_INTERFACE_SERVER)
378
self.server.connect_to_signal("StateChanged",
379
self.server_state_changed)
380
self.server_state_changed(self.server.GetState())
381
382
383
class AvahiServiceToSyslog(AvahiService):
384
def rename(self):
385
"""Add the new name to the syslog messages"""
386
ret = AvahiService.rename(self)
387
syslogger.setFormatter(logging.Formatter
388
('Mandos ({0}) [%(process)d]:'
389
' %(levelname)s: %(message)s'
390
.format(self.name)))
391
return ret
392
393
394
def timedelta_to_milliseconds(td):
395
"Convert a datetime.timedelta() to milliseconds"
396
return ((td.days * 24 * 60 * 60 * 1000)
397
+ (td.seconds * 1000)
398
+ (td.microseconds // 1000))
146
global group
147
if group is None:
148
group = dbus.Interface\
149
(bus.get_object(avahi.DBUS_NAME,
150
server.EntryGroupNew()),
151
avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
group.connect_to_signal('StateChanged',
153
entry_group_state_changed)
154
logger.debug(u"Adding service '%s' of type '%s' ...",
155
service.name, service.type)
156
group.AddService(
157
self.interface, # interface
158
avahi.PROTO_INET6, # protocol
159
dbus.UInt32(0), # flags
160
self.name, self.type,
161
self.domain, self.host,
162
dbus.UInt16(self.port),
163
avahi.string_array_to_txt_array(self.TXT))
164
group.Commit()
165
166
# From the Avahi example code:
167
group = None # our entry group
168
# End of Avahi example code
399
169
400
170
401
171
class Client(object):
402
172
"""A representation of a client host served by this server.
403
404
173
Attributes:
405
approved: bool(); 'None' if not yet approved/disapproved
406
approval_delay: datetime.timedelta(); Time to wait for approval
407
approval_duration: datetime.timedelta(); Duration of one approval
408
checker: subprocess.Popen(); a running checker process used
409
to see if the client lives.
410
'None' if no process is running.
411
checker_callback_tag: a gobject event source tag, or None
412
checker_command: string; External command which is run to check
413
if client lives. %() expansions are done at
174
name: string; from the config file, used in log messages
175
fingerprint: string (40 or 32 hexadecimal digits); used to
176
uniquely identify the client
177
secret: bytestring; sent verbatim (over TLS) to client
178
fqdn: string (FQDN); available for use by the checker command
179
created: datetime.datetime(); object creation, not client host
180
last_checked_ok: datetime.datetime() or None if not yet checked OK
181
timeout: datetime.timedelta(); How long from last_checked_ok
182
until this client is invalid
183
interval: datetime.timedelta(); How often to start a new checker
184
stop_hook: If set, called by stop() as stop_hook(self)
185
checker: subprocess.Popen(); a running checker process used
186
to see if the client lives.
187
'None' if no process is running.
188
checker_initiator_tag: a gobject event source tag, or None
189
stop_initiator_tag: - '' -
190
checker_callback_tag: - '' -
191
checker_command: string; External command which is run to check if
192
client lives. %() expansions are done at
414
193
runtime with vars(self) as dict, so that for
415
194
instance %(name)s can be used in the command.
416
checker_initiator_tag: a gobject event source tag, or None
417
created: datetime.datetime(); (UTC) object creation
418
client_structure: Object describing what attributes a client has
419
and is used for storing the client at exit
420
current_checker_command: string; current running checker_command
421
disable_initiator_tag: a gobject event source tag, or None
422
enabled: bool()
423
fingerprint: string (40 or 32 hexadecimal digits); used to
424
uniquely identify the client
425
host: string; available for use by the checker command
426
interval: datetime.timedelta(); How often to start a new checker
427
last_approval_request: datetime.datetime(); (UTC) or None
428
last_checked_ok: datetime.datetime(); (UTC) or None
429
last_checker_status: integer between 0 and 255 reflecting exit
430
status of last checker. -1 reflects crashed
431
checker, -2 means no checker completed yet.
432
last_enabled: datetime.datetime(); (UTC) or None
433
name: string; from the config file, used in log messages and
434
D-Bus identifiers
435
secret: bytestring; sent verbatim (over TLS) to client
436
timeout: datetime.timedelta(); How long from last_checked_ok
437
until this client is disabled
438
extended_timeout: extra long timeout when secret has been sent
439
runtime_expansions: Allowed attributes for runtime expansion.
440
expires: datetime.datetime(); time (UTC) when a client will be
441
disabled, or None
195
Private attibutes:
196
_timeout: Real variable for 'timeout'
197
_interval: Real variable for 'interval'
198
_timeout_milliseconds: Used when calling gobject.timeout_add()
199
_interval_milliseconds: - '' -
442
200
"""
443
444
runtime_expansions = ("approval_delay", "approval_duration",
445
"created", "enabled", "expires",
446
"fingerprint", "host", "interval",
447
"last_approval_request", "last_checked_ok",
448
"last_enabled", "name", "timeout")
449
client_defaults = { "timeout": "5m",
450
"extended_timeout": "15m",
451
"interval": "2m",
452
"checker": "fping -q -- %%(host)s",
453
"host": "",
454
"approval_delay": "0s",
455
"approval_duration": "1s",
456
"approved_by_default": "True",
457
"enabled": "True",
458
}
459
460
def timeout_milliseconds(self):
461
"Return the 'timeout' attribute in milliseconds"
462
return timedelta_to_milliseconds(self.timeout)
463
464
def extended_timeout_milliseconds(self):
465
"Return the 'extended_timeout' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.extended_timeout)
467
468
def interval_milliseconds(self):
469
"Return the 'interval' attribute in milliseconds"
470
return timedelta_to_milliseconds(self.interval)
471
472
def approval_delay_milliseconds(self):
473
return timedelta_to_milliseconds(self.approval_delay)
474
475
@staticmethod
476
def config_parser(config):
477
"""Construct a new dict of client settings of this form:
478
{ client_name: {setting_name: value, ...}, ...}
479
with exceptions for any special settings as defined above.
480
NOTE: Must be a pure function. Must return the same result
481
value given the same arguments.
482
"""
483
settings = {}
484
for client_name in config.sections():
485
section = dict(config.items(client_name))
486
client = settings[client_name] = {}
487
488
client["host"] = section["host"]
489
# Reformat values from string types to Python types
490
client["approved_by_default"] = config.getboolean(
491
client_name, "approved_by_default")
492
client["enabled"] = config.getboolean(client_name,
493
"enabled")
494
495
client["fingerprint"] = (section["fingerprint"].upper()
496
.replace(" ", ""))
497
if "secret" in section:
498
client["secret"] = section["secret"].decode("base64")
499
elif "secfile" in section:
500
with open(os.path.expanduser(os.path.expandvars
501
(section["secfile"])),
502
"rb") as secfile:
503
client["secret"] = secfile.read()
504
else:
505
raise TypeError("No secret or secfile for section {0}"
506
.format(section))
507
client["timeout"] = string_to_delta(section["timeout"])
508
client["extended_timeout"] = string_to_delta(
509
section["extended_timeout"])
510
client["interval"] = string_to_delta(section["interval"])
511
client["approval_delay"] = string_to_delta(
512
section["approval_delay"])
513
client["approval_duration"] = string_to_delta(
514
section["approval_duration"])
515
client["checker_command"] = section["checker"]
516
client["last_approval_request"] = None
517
client["last_checked_ok"] = None
518
client["last_checker_status"] = -2
519
520
return settings
521
522
def __init__(self, settings, name = None):
201
def _set_timeout(self, timeout):
202
"Setter function for 'timeout' attribute"
203
self._timeout = timeout
204
self._timeout_milliseconds = ((self.timeout.days
205
* 24 * 60 * 60 * 1000)
206
+ (self.timeout.seconds * 1000)
207
+ (self.timeout.microseconds
208
// 1000))
209
timeout = property(lambda self: self._timeout,
210
_set_timeout)
211
del _set_timeout
212
def _set_interval(self, interval):
213
"Setter function for 'interval' attribute"
214
self._interval = interval
215
self._interval_milliseconds = ((self.interval.days
216
* 24 * 60 * 60 * 1000)
217
+ (self.interval.seconds
218
* 1000)
219
+ (self.interval.microseconds
220
// 1000))
221
interval = property(lambda self: self._interval,
222
_set_interval)
223
del _set_interval
224
def __init__(self, name=None, stop_hook=None, fingerprint=None,
225
secret=None, secfile=None, fqdn=None, timeout=None,
226
interval=-1, checker=None):
227
"""Note: the 'checker' argument sets the 'checker_command'
228
attribute and not the 'checker' attribute.."""
523
229
self.name = name
524
# adding all client settings
525
for setting, value in settings.iteritems():
526
setattr(self, setting, value)
527
528
if self.enabled:
529
if not hasattr(self, "last_enabled"):
530
self.last_enabled = datetime.datetime.utcnow()
531
if not hasattr(self, "expires"):
532
self.expires = (datetime.datetime.utcnow()
533
+ self.timeout)
230
logger.debug(u"Creating client %r", self.name)
231
# Uppercase and remove spaces from fingerprint
232
# for later comparison purposes with return value of
233
# the fingerprint() function
234
self.fingerprint = fingerprint.upper().replace(u" ", u"")
235
logger.debug(u" Fingerprint: %s", self.fingerprint)
236
if secret:
237
self.secret = secret.decode(u"base64")
238
elif secfile:
239
sf = open(secfile)
240
self.secret = sf.read()
241
sf.close()
534
242
else:
535
self.last_enabled = None
536
self.expires = None
537
538
logger.debug("Creating client %r", self.name)
539
# Uppercase and remove spaces from fingerprint for later
540
# comparison purposes with return value from the fingerprint()
541
# function
542
logger.debug(" Fingerprint: %s", self.fingerprint)
543
self.created = settings.get("created",
544
datetime.datetime.utcnow())
545
546
# attributes specific for this server instance
243
raise TypeError(u"No secret or secfile for client %s"
244
% self.name)
245
self.fqdn = fqdn
246
self.created = datetime.datetime.now()
247
self.last_checked_ok = None
248
self.timeout = string_to_delta(timeout)
249
self.interval = string_to_delta(interval)
250
self.stop_hook = stop_hook
547
251
self.checker = None
548
252
self.checker_initiator_tag = None
549
self.disable_initiator_tag = None
253
self.stop_initiator_tag = None
550
254
self.checker_callback_tag = None
551
self.current_checker_command = None
552
self.approved = None
553
self.approvals_pending = 0
554
self.changedstate = (multiprocessing_manager
555
.Condition(multiprocessing_manager
556
.Lock()))
557
self.client_structure = [attr for attr in
558
self.__dict__.iterkeys()
559
if not attr.startswith("_")]
560
self.client_structure.append("client_structure")
561
562
for name, t in inspect.getmembers(type(self),
563
lambda obj:
564
isinstance(obj,
565
property)):
566
if not name.startswith("_"):
567
self.client_structure.append(name)
568
569
# Send notice to process children that client state has changed
570
def send_changedstate(self):
571
with self.changedstate:
572
self.changedstate.notify_all()
573
574
def enable(self):
255
self.check_command = checker
256
def start(self):
575
257
"""Start this client's checker and timeout hooks"""
576
if getattr(self, "enabled", False):
577
# Already enabled
578
return
579
self.expires = datetime.datetime.utcnow() + self.timeout
580
self.enabled = True
581
self.last_enabled = datetime.datetime.utcnow()
582
self.init_checker()
583
self.send_changedstate()
584
585
def disable(self, quiet=True):
586
"""Disable this client."""
587
if not getattr(self, "enabled", False):
588
return False
589
if not quiet:
590
logger.info("Disabling client %s", self.name)
591
if getattr(self, "disable_initiator_tag", None) is not None:
592
gobject.source_remove(self.disable_initiator_tag)
593
self.disable_initiator_tag = None
594
self.expires = None
595
if getattr(self, "checker_initiator_tag", None) is not None:
596
gobject.source_remove(self.checker_initiator_tag)
597
self.checker_initiator_tag = None
598
self.stop_checker()
599
self.enabled = False
600
if not quiet:
601
self.send_changedstate()
602
# Do not run this again if called by a gobject.timeout_add
603
return False
604
605
def __del__(self):
606
self.disable()
607
608
def init_checker(self):
609
258
# Schedule a new checker to be started an 'interval' from now,
610
259
# and every interval from then on.
611
if self.checker_initiator_tag is not None:
612
gobject.source_remove(self.checker_initiator_tag)
613
self.checker_initiator_tag = (gobject.timeout_add
614
(self.interval_milliseconds(),
615
self.start_checker))
616
# Schedule a disable() when 'timeout' has passed
617
if self.disable_initiator_tag is not None:
618
gobject.source_remove(self.disable_initiator_tag)
619
self.disable_initiator_tag = (gobject.timeout_add
620
(self.timeout_milliseconds(),
621
self.disable))
260
self.checker_initiator_tag = gobject.timeout_add\
261
(self._interval_milliseconds,
262
self.start_checker)
622
263
# Also start a new checker *right now*.
623
264
self.start_checker()
624
625
def checker_callback(self, pid, condition, command):
265
# Schedule a stop() when 'timeout' has passed
266
self.stop_initiator_tag = gobject.timeout_add\
267
(self._timeout_milliseconds,
268
self.stop)
269
def stop(self):
270
"""Stop this client.
271
The possibility that a client might be restarted is left open,
272
but not currently used."""
273
# If this client doesn't have a secret, it is already stopped.
274
if self.secret:
275
logger.debug(u"Stopping client %s", self.name)
276
self.secret = None
277
else:
278
return False
279
if getattr(self, "stop_initiator_tag", False):
280
gobject.source_remove(self.stop_initiator_tag)
281
self.stop_initiator_tag = None
282
if getattr(self, "checker_initiator_tag", False):
283
gobject.source_remove(self.checker_initiator_tag)
284
self.checker_initiator_tag = None
285
self.stop_checker()
286
if self.stop_hook:
287
self.stop_hook(self)
288
# Do not run this again if called by a gobject.timeout_add
289
return False
290
def __del__(self):
291
self.stop_hook = None
292
self.stop()
293
def checker_callback(self, pid, condition):
626
294
"""The checker has completed, so take appropriate actions."""
295
now = datetime.datetime.now()
627
296
self.checker_callback_tag = None
628
297
self.checker = None
629
if os.WIFEXITED(condition):
630
self.last_checker_status = os.WEXITSTATUS(condition)
631
if self.last_checker_status == 0:
632
logger.info("Checker for %(name)s succeeded",
633
vars(self))
634
self.checked_ok()
635
else:
636
logger.info("Checker for %(name)s failed",
637
vars(self))
638
else:
639
self.last_checker_status = -1
640
logger.warning("Checker for %(name)s crashed?",
298
if os.WIFEXITED(condition) \
299
and (os.WEXITSTATUS(condition) == 0):
300
logger.debug(u"Checker for %(name)s succeeded",
301
vars(self))
302
self.last_checked_ok = now
303
gobject.source_remove(self.stop_initiator_tag)
304
self.stop_initiator_tag = gobject.timeout_add\
305
(self._timeout_milliseconds,
306
self.stop)
307
elif not os.WIFEXITED(condition):
308
logger.warning(u"Checker for %(name)s crashed?",
641
309
vars(self))
642
643
def checked_ok(self):
644
"""Assert that the client has been seen, alive and well."""
645
self.last_checked_ok = datetime.datetime.utcnow()
646
self.last_checker_status = 0
647
self.bump_timeout()
648
649
def bump_timeout(self, timeout=None):
650
"""Bump up the timeout for this client."""
651
if timeout is None:
652
timeout = self.timeout
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = None
656
if getattr(self, "enabled", False):
657
self.disable_initiator_tag = (gobject.timeout_add
658
(timedelta_to_milliseconds
659
(timeout), self.disable))
660
self.expires = datetime.datetime.utcnow() + timeout
661
662
def need_approval(self):
663
self.last_approval_request = datetime.datetime.utcnow()
664
310
else:
311
logger.debug(u"Checker for %(name)s failed",
312
vars(self))
665
313
def start_checker(self):
666
314
"""Start a new checker subprocess if one is not running.
667
668
315
If a checker already exists, leave it running and do
669
316
nothing."""
670
317
# The reason for not killing a running checker is that if we
671
# did that, and if a checker (for some reason) started running
672
# slowly and taking more than 'interval' time, then the client
673
# would inevitably timeout, since no checker would get a
674
# chance to run to completion. If we instead leave running
318
# did that, then if a checker (for some reason) started
319
# running slowly and taking more than 'interval' time, the
320
# client would inevitably timeout, since no checker would get
321
# a chance to run to completion. If we instead leave running
675
322
# checkers alone, the checker would have to take more time
676
# than 'timeout' for the client to be disabled, which is as it
677
# should be.
678
679
# If a checker exists, make sure it is not a zombie
680
try:
681
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
682
except (AttributeError, OSError) as error:
683
if (isinstance(error, OSError)
684
and error.errno != errno.ECHILD):
685
raise error
686
else:
687
if pid:
688
logger.warning("Checker was a zombie")
689
gobject.source_remove(self.checker_callback_tag)
690
self.checker_callback(pid, status,
691
self.current_checker_command)
692
# Start a new checker if needed
323
# than 'timeout' for the client to be declared invalid, which
324
# is as it should be.
693
325
if self.checker is None:
694
# Escape attributes for the shell
695
escaped_attrs = dict(
696
(attr, re.escape(unicode(getattr(self, attr))))
697
for attr in
698
self.runtime_expansions)
699
try:
700
command = self.checker_command % escaped_attrs
701
except TypeError as error:
702
logger.error('Could not format string "%s"',
703
self.checker_command, exc_info=error)
704
return True # Try again later
705
self.current_checker_command = command
706
try:
707
logger.info("Starting checker %r for %s",
708
command, self.name)
709
# We don't need to redirect stdout and stderr, since
710
# in normal mode, that is already done by daemon(),
711
# and in debug mode we don't want to. (Stdin is
712
# always replaced by /dev/null.)
326
try:
327
# In case check_command has exactly one % operator
328
command = self.check_command % self.fqdn
329
except TypeError:
330
# Escape attributes for the shell
331
escaped_attrs = dict((key, re.escape(str(val)))
332
for key, val in
333
vars(self).iteritems())
334
try:
335
command = self.check_command % escaped_attrs
336
except TypeError, error:
337
logger.error(u'Could not format string "%s":'
338
u' %s', self.check_command, error)
339
return True # Try again later
340
try:
341
logger.debug(u"Starting checker %r for %s",
342
command, self.name)
713
343
self.checker = subprocess.Popen(command,
714
344
close_fds=True,
715
345
shell=True, cwd="/")
716
except OSError as error:
717
logger.error("Failed to start subprocess",
718
exc_info=error)
719
self.checker_callback_tag = (gobject.child_watch_add
720
(self.checker.pid,
721
self.checker_callback,
722
data=command))
723
# The checker may have completed before the gobject
724
# watch was added. Check for this.
725
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
726
if pid:
727
gobject.source_remove(self.checker_callback_tag)
728
self.checker_callback(pid, status, command)
346
self.checker_callback_tag = gobject.child_watch_add\
347
(self.checker.pid,
348
self.checker_callback)
349
except subprocess.OSError, error:
350
logger.error(u"Failed to start subprocess: %s",
351
error)
729
352
# Re-run this periodically if run by gobject.timeout_add
730
353
return True
731
732
354
def stop_checker(self):
733
355
"""Force the checker process, if any, to stop."""
734
356
if self.checker_callback_tag:
738
360
return
739
361
logger.debug("Stopping checker for %(name)s", vars(self))
740
362
try:
741
self.checker.terminate()
742
#time.sleep(0.5)
363
os.kill(self.checker.pid, signal.SIGTERM)
364
#os.sleep(0.5)
743
365
#if self.checker.poll() is None:
744
# self.checker.kill()
745
except OSError as error:
366
# os.kill(self.checker.pid, signal.SIGKILL)
367
except OSError, error:
746
368
if error.errno != errno.ESRCH: # No such process
747
369
raise
748
370
self.checker = None
749
750
751
def dbus_service_property(dbus_interface, signature="v",
752
access="readwrite", byte_arrays=False):
753
"""Decorators for marking methods of a DBusObjectWithProperties to
754
become properties on the D-Bus.
755
756
The decorated method will be called with no arguments by "Get"
757
and with one argument by "Set".
758
759
The parameters, where they are supported, are the same as
760
dbus.service.method, except there is only "signature", since the
761
type from Get() and the type sent to Set() is the same.
762
"""
763
# Encoding deeply encoded byte arrays is not supported yet by the
764
# "Set" method, so we fail early here:
765
if byte_arrays and signature != "ay":
766
raise ValueError("Byte arrays not supported for non-'ay'"
767
" signature {0!r}".format(signature))
768
def decorator(func):
769
func._dbus_is_property = True
770
func._dbus_interface = dbus_interface
771
func._dbus_signature = signature
772
func._dbus_access = access
773
func._dbus_name = func.__name__
774
if func._dbus_name.endswith("_dbus_property"):
775
func._dbus_name = func._dbus_name[:-14]
776
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
777
return func
778
return decorator
779
780
781
def dbus_interface_annotations(dbus_interface):
782
"""Decorator for marking functions returning interface annotations
783
784
Usage:
785
786
@dbus_interface_annotations("org.example.Interface")
787
def _foo(self): # Function name does not matter
788
return {"org.freedesktop.DBus.Deprecated": "true",
789
"org.freedesktop.DBus.Property.EmitsChangedSignal":
790
"false"}
791
"""
792
def decorator(func):
793
func._dbus_is_interface = True
794
func._dbus_interface = dbus_interface
795
func._dbus_name = dbus_interface
796
return func
797
return decorator
798
799
800
def dbus_annotations(annotations):
801
"""Decorator to annotate D-Bus methods, signals or properties
802
Usage:
803
804
@dbus_service_property("org.example.Interface", signature="b",
805
access="r")
806
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
807
"org.freedesktop.DBus.Property."
808
"EmitsChangedSignal": "false"})
809
def Property_dbus_property(self):
810
return dbus.Boolean(False)
811
"""
812
def decorator(func):
813
func._dbus_annotations = annotations
814
return func
815
return decorator
816
817
818
class DBusPropertyException(dbus.exceptions.DBusException):
819
"""A base class for D-Bus property-related exceptions
820
"""
821
def __unicode__(self):
822
return unicode(str(self))
823
824
825
class DBusPropertyAccessException(DBusPropertyException):
826
"""A property's access permissions disallows an operation.
827
"""
828
pass
829
830
831
class DBusPropertyNotFound(DBusPropertyException):
832
"""An attempt was made to access a non-existing property.
833
"""
834
pass
835
836
837
class DBusObjectWithProperties(dbus.service.Object):
838
"""A D-Bus object with properties.
839
840
Classes inheriting from this can use the dbus_service_property
841
decorator to expose methods as D-Bus properties. It exposes the
842
standard Get(), Set(), and GetAll() methods on the D-Bus.
843
"""
844
845
@staticmethod
846
def _is_dbus_thing(thing):
847
"""Returns a function testing if an attribute is a D-Bus thing
848
849
If called like _is_dbus_thing("method") it returns a function
850
suitable for use as predicate to inspect.getmembers().
851
"""
852
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
853
False)
854
855
def _get_all_dbus_things(self, thing):
856
"""Returns a generator of (name, attribute) pairs
857
"""
858
return ((getattr(athing.__get__(self), "_dbus_name",
859
name),
860
athing.__get__(self))
861
for cls in self.__class__.__mro__
862
for name, athing in
863
inspect.getmembers(cls,
864
self._is_dbus_thing(thing)))
865
866
def _get_dbus_property(self, interface_name, property_name):
867
"""Returns a bound method if one exists which is a D-Bus
868
property with the specified name and interface.
869
"""
870
for cls in self.__class__.__mro__:
871
for name, value in (inspect.getmembers
872
(cls,
873
self._is_dbus_thing("property"))):
874
if (value._dbus_name == property_name
875
and value._dbus_interface == interface_name):
876
return value.__get__(self)
877
878
# No such property
879
raise DBusPropertyNotFound(self.dbus_object_path + ":"
880
+ interface_name + "."
881
+ property_name)
882
883
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
884
out_signature="v")
885
def Get(self, interface_name, property_name):
886
"""Standard D-Bus property Get() method, see D-Bus standard.
887
"""
888
prop = self._get_dbus_property(interface_name, property_name)
889
if prop._dbus_access == "write":
890
raise DBusPropertyAccessException(property_name)
891
value = prop()
892
if not hasattr(value, "variant_level"):
893
return value
894
return type(value)(value, variant_level=value.variant_level+1)
895
896
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
897
def Set(self, interface_name, property_name, value):
898
"""Standard D-Bus property Set() method, see D-Bus standard.
899
"""
900
prop = self._get_dbus_property(interface_name, property_name)
901
if prop._dbus_access == "read":
902
raise DBusPropertyAccessException(property_name)
903
if prop._dbus_get_args_options["byte_arrays"]:
904
# The byte_arrays option is not supported yet on
905
# signatures other than "ay".
906
if prop._dbus_signature != "ay":
907
raise ValueError
908
value = dbus.ByteArray(b''.join(chr(byte)
909
for byte in value))
910
prop(value)
911
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
913
out_signature="a{sv}")
914
def GetAll(self, interface_name):
915
"""Standard D-Bus property GetAll() method, see D-Bus
916
standard.
917
918
Note: Will not include properties with access="write".
919
"""
920
properties = {}
921
for name, prop in self._get_all_dbus_things("property"):
922
if (interface_name
923
and interface_name != prop._dbus_interface):
924
# Interface non-empty but did not match
925
continue
926
# Ignore write-only properties
927
if prop._dbus_access == "write":
928
continue
929
value = prop()
930
if not hasattr(value, "variant_level"):
931
properties[name] = value
932
continue
933
properties[name] = type(value)(value, variant_level=
934
value.variant_level+1)
935
return dbus.Dictionary(properties, signature="sv")
936
937
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
938
out_signature="s",
939
path_keyword='object_path',
940
connection_keyword='connection')
941
def Introspect(self, object_path, connection):
942
"""Overloading of standard D-Bus method.
943
944
Inserts property tags and interface annotation tags.
945
"""
946
xmlstring = dbus.service.Object.Introspect(self, object_path,
947
connection)
948
try:
949
document = xml.dom.minidom.parseString(xmlstring)
950
def make_tag(document, name, prop):
951
e = document.createElement("property")
952
e.setAttribute("name", name)
953
e.setAttribute("type", prop._dbus_signature)
954
e.setAttribute("access", prop._dbus_access)
955
return e
956
for if_tag in document.getElementsByTagName("interface"):
957
# Add property tags
958
for tag in (make_tag(document, name, prop)
959
for name, prop
960
in self._get_all_dbus_things("property")
961
if prop._dbus_interface
962
== if_tag.getAttribute("name")):
963
if_tag.appendChild(tag)
964
# Add annotation tags
965
for typ in ("method", "signal", "property"):
966
for tag in if_tag.getElementsByTagName(typ):
967
annots = dict()
968
for name, prop in (self.
969
_get_all_dbus_things(typ)):
970
if (name == tag.getAttribute("name")
971
and prop._dbus_interface
972
== if_tag.getAttribute("name")):
973
annots.update(getattr
974
(prop,
975
"_dbus_annotations",
976
{}))
977
for name, value in annots.iteritems():
978
ann_tag = document.createElement(
979
"annotation")
980
ann_tag.setAttribute("name", name)
981
ann_tag.setAttribute("value", value)
982
tag.appendChild(ann_tag)
983
# Add interface annotation tags
984
for annotation, value in dict(
985
itertools.chain.from_iterable(
986
annotations().iteritems()
987
for name, annotations in
988
self._get_all_dbus_things("interface")
989
if name == if_tag.getAttribute("name")
990
)).iteritems():
991
ann_tag = document.createElement("annotation")
992
ann_tag.setAttribute("name", annotation)
993
ann_tag.setAttribute("value", value)
994
if_tag.appendChild(ann_tag)
995
# Add the names to the return values for the
996
# "org.freedesktop.DBus.Properties" methods
997
if (if_tag.getAttribute("name")
998
== "org.freedesktop.DBus.Properties"):
999
for cn in if_tag.getElementsByTagName("method"):
1000
if cn.getAttribute("name") == "Get":
1001
for arg in cn.getElementsByTagName("arg"):
1002
if (arg.getAttribute("direction")
1003
== "out"):
1004
arg.setAttribute("name", "value")
1005
elif cn.getAttribute("name") == "GetAll":
1006
for arg in cn.getElementsByTagName("arg"):
1007
if (arg.getAttribute("direction")
1008
== "out"):
1009
arg.setAttribute("name", "props")
1010
xmlstring = document.toxml("utf-8")
1011
document.unlink()
1012
except (AttributeError, xml.dom.DOMException,
1013
xml.parsers.expat.ExpatError) as error:
1014
logger.error("Failed to override Introspection method",
1015
exc_info=error)
1016
return xmlstring
1017
1018
1019
def datetime_to_dbus(dt, variant_level=0):
1020
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1021
if dt is None:
1022
return dbus.String("", variant_level = variant_level)
1023
return dbus.String(dt.isoformat(),
1024
variant_level=variant_level)
1025
1026
1027
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1028
"""A class decorator; applied to a subclass of
1029
dbus.service.Object, it will add alternate D-Bus attributes with
1030
interface names according to the "alt_interface_names" mapping.
1031
Usage:
1032
1033
@alternate_dbus_interfaces({"org.example.Interface":
1034
"net.example.AlternateInterface"})
1035
class SampleDBusObject(dbus.service.Object):
1036
@dbus.service.method("org.example.Interface")
1037
def SampleDBusMethod():
1038
pass
1039
1040
The above "SampleDBusMethod" on "SampleDBusObject" will be
1041
reachable via two interfaces: "org.example.Interface" and
1042
"net.example.AlternateInterface", the latter of which will have
1043
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1044
"true", unless "deprecate" is passed with a False value.
1045
1046
This works for methods and signals, and also for D-Bus properties
1047
(from DBusObjectWithProperties) and interfaces (from the
1048
dbus_interface_annotations decorator).
1049
"""
1050
def wrapper(cls):
1051
for orig_interface_name, alt_interface_name in (
1052
alt_interface_names.iteritems()):
1053
attr = {}
1054
interface_names = set()
1055
# Go though all attributes of the class
1056
for attrname, attribute in inspect.getmembers(cls):
1057
# Ignore non-D-Bus attributes, and D-Bus attributes
1058
# with the wrong interface name
1059
if (not hasattr(attribute, "_dbus_interface")
1060
or not attribute._dbus_interface
1061
.startswith(orig_interface_name)):
1062
continue
1063
# Create an alternate D-Bus interface name based on
1064
# the current name
1065
alt_interface = (attribute._dbus_interface
1066
.replace(orig_interface_name,
1067
alt_interface_name))
1068
interface_names.add(alt_interface)
1069
# Is this a D-Bus signal?
1070
if getattr(attribute, "_dbus_is_signal", False):
1071
# Extract the original non-method function by
1072
# black magic
1073
nonmethod_func = (dict(
1074
zip(attribute.func_code.co_freevars,
1075
attribute.__closure__))["func"]
1076
.cell_contents)
1077
# Create a new, but exactly alike, function
1078
# object, and decorate it to be a new D-Bus signal
1079
# with the alternate D-Bus interface name
1080
new_function = (dbus.service.signal
1081
(alt_interface,
1082
attribute._dbus_signature)
1083
(types.FunctionType(
1084
nonmethod_func.func_code,
1085
nonmethod_func.func_globals,
1086
nonmethod_func.func_name,
1087
nonmethod_func.func_defaults,
1088
nonmethod_func.func_closure)))
1089
# Copy annotations, if any
1090
try:
1091
new_function._dbus_annotations = (
1092
dict(attribute._dbus_annotations))
1093
except AttributeError:
1094
pass
1095
# Define a creator of a function to call both the
1096
# original and alternate functions, so both the
1097
# original and alternate signals gets sent when
1098
# the function is called
1099
def fixscope(func1, func2):
1100
"""This function is a scope container to pass
1101
func1 and func2 to the "call_both" function
1102
outside of its arguments"""
1103
def call_both(*args, **kwargs):
1104
"""This function will emit two D-Bus
1105
signals by calling func1 and func2"""
1106
func1(*args, **kwargs)
1107
func2(*args, **kwargs)
1108
return call_both
1109
# Create the "call_both" function and add it to
1110
# the class
1111
attr[attrname] = fixscope(attribute, new_function)
1112
# Is this a D-Bus method?
1113
elif getattr(attribute, "_dbus_is_method", False):
1114
# Create a new, but exactly alike, function
1115
# object. Decorate it to be a new D-Bus method
1116
# with the alternate D-Bus interface name. Add it
1117
# to the class.
1118
attr[attrname] = (dbus.service.method
1119
(alt_interface,
1120
attribute._dbus_in_signature,
1121
attribute._dbus_out_signature)
1122
(types.FunctionType
1123
(attribute.func_code,
1124
attribute.func_globals,
1125
attribute.func_name,
1126
attribute.func_defaults,
1127
attribute.func_closure)))
1128
# Copy annotations, if any
1129
try:
1130
attr[attrname]._dbus_annotations = (
1131
dict(attribute._dbus_annotations))
1132
except AttributeError:
1133
pass
1134
# Is this a D-Bus property?
1135
elif getattr(attribute, "_dbus_is_property", False):
1136
# Create a new, but exactly alike, function
1137
# object, and decorate it to be a new D-Bus
1138
# property with the alternate D-Bus interface
1139
# name. Add it to the class.
1140
attr[attrname] = (dbus_service_property
1141
(alt_interface,
1142
attribute._dbus_signature,
1143
attribute._dbus_access,
1144
attribute
1145
._dbus_get_args_options
1146
["byte_arrays"])
1147
(types.FunctionType
1148
(attribute.func_code,
1149
attribute.func_globals,
1150
attribute.func_name,
1151
attribute.func_defaults,
1152
attribute.func_closure)))
1153
# Copy annotations, if any
1154
try:
1155
attr[attrname]._dbus_annotations = (
1156
dict(attribute._dbus_annotations))
1157
except AttributeError:
1158
pass
1159
# Is this a D-Bus interface?
1160
elif getattr(attribute, "_dbus_is_interface", False):
1161
# Create a new, but exactly alike, function
1162
# object. Decorate it to be a new D-Bus interface
1163
# with the alternate D-Bus interface name. Add it
1164
# to the class.
1165
attr[attrname] = (dbus_interface_annotations
1166
(alt_interface)
1167
(types.FunctionType
1168
(attribute.func_code,
1169
attribute.func_globals,
1170
attribute.func_name,
1171
attribute.func_defaults,
1172
attribute.func_closure)))
1173
if deprecate:
1174
# Deprecate all alternate interfaces
1175
iname="_AlternateDBusNames_interface_annotation{0}"
1176
for interface_name in interface_names:
1177
@dbus_interface_annotations(interface_name)
1178
def func(self):
1179
return { "org.freedesktop.DBus.Deprecated":
1180
"true" }
1181
# Find an unused name
1182
for aname in (iname.format(i)
1183
for i in itertools.count()):
1184
if aname not in attr:
1185
attr[aname] = func
1186
break
1187
if interface_names:
1188
# Replace the class with a new subclass of it with
1189
# methods, signals, etc. as created above.
1190
cls = type(b"{0}Alternate".format(cls.__name__),
1191
(cls,), attr)
1192
return cls
1193
return wrapper
1194
1195
1196
@alternate_dbus_interfaces({"se.recompile.Mandos":
1197
"se.bsnet.fukt.Mandos"})
1198
class ClientDBus(Client, DBusObjectWithProperties):
1199
"""A Client class using D-Bus
1200
1201
Attributes:
1202
dbus_object_path: dbus.ObjectPath
1203
bus: dbus.SystemBus()
1204
"""
1205
1206
runtime_expansions = (Client.runtime_expansions
1207
+ ("dbus_object_path",))
1208
1209
# dbus.service.Object doesn't use super(), so we can't either.
1210
1211
def __init__(self, bus = None, *args, **kwargs):
1212
self.bus = bus
1213
Client.__init__(self, *args, **kwargs)
1214
# Only now, when this client is initialized, can it show up on
1215
# the D-Bus
1216
client_object_name = unicode(self.name).translate(
1217
{ord("."): ord("_"),
1218
ord("-"): ord("_")})
1219
self.dbus_object_path = (dbus.ObjectPath
1220
("/clients/" + client_object_name))
1221
DBusObjectWithProperties.__init__(self, self.bus,
1222
self.dbus_object_path)
1223
1224
def notifychangeproperty(transform_func,
1225
dbus_name, type_func=lambda x: x,
1226
variant_level=1):
1227
""" Modify a variable so that it's a property which announces
1228
its changes to DBus.
1229
1230
transform_fun: Function that takes a value and a variant_level
1231
and transforms it to a D-Bus type.
1232
dbus_name: D-Bus name of the variable
1233
type_func: Function that transform the value before sending it
1234
to the D-Bus. Default: no transform
1235
variant_level: D-Bus variant level. Default: 1
1236
"""
1237
attrname = "_{0}".format(dbus_name)
1238
def setter(self, value):
1239
if hasattr(self, "dbus_object_path"):
1240
if (not hasattr(self, attrname) or
1241
type_func(getattr(self, attrname, None))
1242
!= type_func(value)):
1243
dbus_value = transform_func(type_func(value),
1244
variant_level
1245
=variant_level)
1246
self.PropertyChanged(dbus.String(dbus_name),
1247
dbus_value)
1248
setattr(self, attrname, value)
1249
1250
return property(lambda self: getattr(self, attrname), setter)
1251
1252
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1253
approvals_pending = notifychangeproperty(dbus.Boolean,
1254
"ApprovalPending",
1255
type_func = bool)
1256
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1257
last_enabled = notifychangeproperty(datetime_to_dbus,
1258
"LastEnabled")
1259
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1260
type_func = lambda checker:
1261
checker is not None)
1262
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1263
"LastCheckedOK")
1264
last_checker_status = notifychangeproperty(dbus.Int16,
1265
"LastCheckerStatus")
1266
last_approval_request = notifychangeproperty(
1267
datetime_to_dbus, "LastApprovalRequest")
1268
approved_by_default = notifychangeproperty(dbus.Boolean,
1269
"ApprovedByDefault")
1270
approval_delay = notifychangeproperty(dbus.UInt64,
1271
"ApprovalDelay",
1272
type_func =
1273
timedelta_to_milliseconds)
1274
approval_duration = notifychangeproperty(
1275
dbus.UInt64, "ApprovalDuration",
1276
type_func = timedelta_to_milliseconds)
1277
host = notifychangeproperty(dbus.String, "Host")
1278
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1279
type_func =
1280
timedelta_to_milliseconds)
1281
extended_timeout = notifychangeproperty(
1282
dbus.UInt64, "ExtendedTimeout",
1283
type_func = timedelta_to_milliseconds)
1284
interval = notifychangeproperty(dbus.UInt64,
1285
"Interval",
1286
type_func =
1287
timedelta_to_milliseconds)
1288
checker_command = notifychangeproperty(dbus.String, "Checker")
1289
1290
del notifychangeproperty
1291
1292
def __del__(self, *args, **kwargs):
1293
try:
1294
self.remove_from_connection()
1295
except LookupError:
1296
pass
1297
if hasattr(DBusObjectWithProperties, "__del__"):
1298
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1299
Client.__del__(self, *args, **kwargs)
1300
1301
def checker_callback(self, pid, condition, command,
1302
*args, **kwargs):
1303
self.checker_callback_tag = None
1304
self.checker = None
1305
if os.WIFEXITED(condition):
1306
exitstatus = os.WEXITSTATUS(condition)
1307
# Emit D-Bus signal
1308
self.CheckerCompleted(dbus.Int16(exitstatus),
1309
dbus.Int64(condition),
1310
dbus.String(command))
1311
else:
1312
# Emit D-Bus signal
1313
self.CheckerCompleted(dbus.Int16(-1),
1314
dbus.Int64(condition),
1315
dbus.String(command))
1316
1317
return Client.checker_callback(self, pid, condition, command,
1318
*args, **kwargs)
1319
1320
def start_checker(self, *args, **kwargs):
1321
old_checker = self.checker
1322
if self.checker is not None:
1323
old_checker_pid = self.checker.pid
1324
else:
1325
old_checker_pid = None
1326
r = Client.start_checker(self, *args, **kwargs)
1327
# Only if new checker process was started
1328
if (self.checker is not None
1329
and old_checker_pid != self.checker.pid):
1330
# Emit D-Bus signal
1331
self.CheckerStarted(self.current_checker_command)
1332
return r
1333
1334
def _reset_approved(self):
1335
self.approved = None
1336
return False
1337
1338
def approve(self, value=True):
1339
self.approved = value
1340
gobject.timeout_add(timedelta_to_milliseconds
1341
(self.approval_duration),
1342
self._reset_approved)
1343
self.send_changedstate()
1344
1345
## D-Bus methods, signals & properties
1346
_interface = "se.recompile.Mandos.Client"
1347
1348
## Interfaces
1349
1350
@dbus_interface_annotations(_interface)
1351
def _foo(self):
1352
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1353
"false"}
1354
1355
## Signals
1356
1357
# CheckerCompleted - signal
1358
@dbus.service.signal(_interface, signature="nxs")
1359
def CheckerCompleted(self, exitcode, waitstatus, command):
1360
"D-Bus signal"
1361
pass
1362
1363
# CheckerStarted - signal
1364
@dbus.service.signal(_interface, signature="s")
1365
def CheckerStarted(self, command):
1366
"D-Bus signal"
1367
pass
1368
1369
# PropertyChanged - signal
1370
@dbus.service.signal(_interface, signature="sv")
1371
def PropertyChanged(self, property, value):
1372
"D-Bus signal"
1373
pass
1374
1375
# GotSecret - signal
1376
@dbus.service.signal(_interface)
1377
def GotSecret(self):
1378
"""D-Bus signal
1379
Is sent after a successful transfer of secret from the Mandos
1380
server to mandos-client
1381
"""
1382
pass
1383
1384
# Rejected - signal
1385
@dbus.service.signal(_interface, signature="s")
1386
def Rejected(self, reason):
1387
"D-Bus signal"
1388
pass
1389
1390
# NeedApproval - signal
1391
@dbus.service.signal(_interface, signature="tb")
1392
def NeedApproval(self, timeout, default):
1393
"D-Bus signal"
1394
return self.need_approval()
1395
1396
## Methods
1397
1398
# Approve - method
1399
@dbus.service.method(_interface, in_signature="b")
1400
def Approve(self, value):
1401
self.approve(value)
1402
1403
# CheckedOK - method
1404
@dbus.service.method(_interface)
1405
def CheckedOK(self):
1406
self.checked_ok()
1407
1408
# Enable - method
1409
@dbus.service.method(_interface)
1410
def Enable(self):
1411
"D-Bus method"
1412
self.enable()
1413
1414
# StartChecker - method
1415
@dbus.service.method(_interface)
1416
def StartChecker(self):
1417
"D-Bus method"
1418
self.start_checker()
1419
1420
# Disable - method
1421
@dbus.service.method(_interface)
1422
def Disable(self):
1423
"D-Bus method"
1424
self.disable()
1425
1426
# StopChecker - method
1427
@dbus.service.method(_interface)
1428
def StopChecker(self):
1429
self.stop_checker()
1430
1431
## Properties
1432
1433
# ApprovalPending - property
1434
@dbus_service_property(_interface, signature="b", access="read")
1435
def ApprovalPending_dbus_property(self):
1436
return dbus.Boolean(bool(self.approvals_pending))
1437
1438
# ApprovedByDefault - property
1439
@dbus_service_property(_interface, signature="b",
1440
access="readwrite")
1441
def ApprovedByDefault_dbus_property(self, value=None):
1442
if value is None: # get
1443
return dbus.Boolean(self.approved_by_default)
1444
self.approved_by_default = bool(value)
1445
1446
# ApprovalDelay - property
1447
@dbus_service_property(_interface, signature="t",
1448
access="readwrite")
1449
def ApprovalDelay_dbus_property(self, value=None):
1450
if value is None: # get
1451
return dbus.UInt64(self.approval_delay_milliseconds())
1452
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1453
1454
# ApprovalDuration - property
1455
@dbus_service_property(_interface, signature="t",
1456
access="readwrite")
1457
def ApprovalDuration_dbus_property(self, value=None):
1458
if value is None: # get
1459
return dbus.UInt64(timedelta_to_milliseconds(
1460
self.approval_duration))
1461
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1462
1463
# Name - property
1464
@dbus_service_property(_interface, signature="s", access="read")
1465
def Name_dbus_property(self):
1466
return dbus.String(self.name)
1467
1468
# Fingerprint - property
1469
@dbus_service_property(_interface, signature="s", access="read")
1470
def Fingerprint_dbus_property(self):
1471
return dbus.String(self.fingerprint)
1472
1473
# Host - property
1474
@dbus_service_property(_interface, signature="s",
1475
access="readwrite")
1476
def Host_dbus_property(self, value=None):
1477
if value is None: # get
1478
return dbus.String(self.host)
1479
self.host = unicode(value)
1480
1481
# Created - property
1482
@dbus_service_property(_interface, signature="s", access="read")
1483
def Created_dbus_property(self):
1484
return datetime_to_dbus(self.created)
1485
1486
# LastEnabled - property
1487
@dbus_service_property(_interface, signature="s", access="read")
1488
def LastEnabled_dbus_property(self):
1489
return datetime_to_dbus(self.last_enabled)
1490
1491
# Enabled - property
1492
@dbus_service_property(_interface, signature="b",
1493
access="readwrite")
1494
def Enabled_dbus_property(self, value=None):
1495
if value is None: # get
1496
return dbus.Boolean(self.enabled)
1497
if value:
1498
self.enable()
1499
else:
1500
self.disable()
1501
1502
# LastCheckedOK - property
1503
@dbus_service_property(_interface, signature="s",
1504
access="readwrite")
1505
def LastCheckedOK_dbus_property(self, value=None):
1506
if value is not None:
1507
self.checked_ok()
1508
return
1509
return datetime_to_dbus(self.last_checked_ok)
1510
1511
# LastCheckerStatus - property
1512
@dbus_service_property(_interface, signature="n",
1513
access="read")
1514
def LastCheckerStatus_dbus_property(self):
1515
return dbus.Int16(self.last_checker_status)
1516
1517
# Expires - property
1518
@dbus_service_property(_interface, signature="s", access="read")
1519
def Expires_dbus_property(self):
1520
return datetime_to_dbus(self.expires)
1521
1522
# LastApprovalRequest - property
1523
@dbus_service_property(_interface, signature="s", access="read")
1524
def LastApprovalRequest_dbus_property(self):
1525
return datetime_to_dbus(self.last_approval_request)
1526
1527
# Timeout - property
1528
@dbus_service_property(_interface, signature="t",
1529
access="readwrite")
1530
def Timeout_dbus_property(self, value=None):
1531
if value is None: # get
1532
return dbus.UInt64(self.timeout_milliseconds())
1533
old_timeout = self.timeout
1534
self.timeout = datetime.timedelta(0, 0, 0, value)
1535
# Reschedule disabling
1536
if self.enabled:
1537
now = datetime.datetime.utcnow()
1538
self.expires += self.timeout - old_timeout
1539
if self.expires <= now:
1540
# The timeout has passed
1541
self.disable()
1542
else:
1543
if (getattr(self, "disable_initiator_tag", None)
1544
is None):
1545
return
1546
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (
1548
gobject.timeout_add(
1549
timedelta_to_milliseconds(self.expires - now),
1550
self.disable))
1551
1552
# ExtendedTimeout - property
1553
@dbus_service_property(_interface, signature="t",
1554
access="readwrite")
1555
def ExtendedTimeout_dbus_property(self, value=None):
1556
if value is None: # get
1557
return dbus.UInt64(self.extended_timeout_milliseconds())
1558
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1559
1560
# Interval - property
1561
@dbus_service_property(_interface, signature="t",
1562
access="readwrite")
1563
def Interval_dbus_property(self, value=None):
1564
if value is None: # get
1565
return dbus.UInt64(self.interval_milliseconds())
1566
self.interval = datetime.timedelta(0, 0, 0, value)
1567
if getattr(self, "checker_initiator_tag", None) is None:
1568
return
1569
if self.enabled:
1570
# Reschedule checker run
1571
gobject.source_remove(self.checker_initiator_tag)
1572
self.checker_initiator_tag = (gobject.timeout_add
1573
(value, self.start_checker))
1574
self.start_checker() # Start one now, too
1575
1576
# Checker - property
1577
@dbus_service_property(_interface, signature="s",
1578
access="readwrite")
1579
def Checker_dbus_property(self, value=None):
1580
if value is None: # get
1581
return dbus.String(self.checker_command)
1582
self.checker_command = unicode(value)
1583
1584
# CheckerRunning - property
1585
@dbus_service_property(_interface, signature="b",
1586
access="readwrite")
1587
def CheckerRunning_dbus_property(self, value=None):
1588
if value is None: # get
1589
return dbus.Boolean(self.checker is not None)
1590
if value:
1591
self.start_checker()
1592
else:
1593
self.stop_checker()
1594
1595
# ObjectPath - property
1596
@dbus_service_property(_interface, signature="o", access="read")
1597
def ObjectPath_dbus_property(self):
1598
return self.dbus_object_path # is already a dbus.ObjectPath
1599
1600
# Secret = property
1601
@dbus_service_property(_interface, signature="ay",
1602
access="write", byte_arrays=True)
1603
def Secret_dbus_property(self, value):
1604
self.secret = str(value)
1605
1606
del _interface
1607
1608
1609
class ProxyClient(object):
1610
def __init__(self, child_pipe, fpr, address):
1611
self._pipe = child_pipe
1612
self._pipe.send(('init', fpr, address))
1613
if not self._pipe.recv():
1614
raise KeyError()
1615
1616
def __getattribute__(self, name):
1617
if name == '_pipe':
1618
return super(ProxyClient, self).__getattribute__(name)
1619
self._pipe.send(('getattr', name))
1620
data = self._pipe.recv()
1621
if data[0] == 'data':
1622
return data[1]
1623
if data[0] == 'function':
1624
def func(*args, **kwargs):
1625
self._pipe.send(('funcall', name, args, kwargs))
1626
return self._pipe.recv()[1]
1627
return func
1628
1629
def __setattr__(self, name, value):
1630
if name == '_pipe':
1631
return super(ProxyClient, self).__setattr__(name, value)
1632
self._pipe.send(('setattr', name, value))
1633
1634
1635
class ClientHandler(socketserver.BaseRequestHandler, object):
1636
"""A class to handle client connections.
1637
1638
Instantiated once for each connection to handle it.
371
def still_valid(self):
372
"""Has the timeout not yet passed for this client?"""
373
now = datetime.datetime.now()
374
if self.last_checked_ok is None:
375
return now < (self.created + self.timeout)
376
else:
377
return now < (self.last_checked_ok + self.timeout)
378
379
380
def peer_certificate(session):
381
"Return the peer's OpenPGP certificate as a bytestring"
382
# If not an OpenPGP certificate...
383
if gnutls.library.functions.gnutls_certificate_type_get\
384
(session._c_object) \
385
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP:
386
# ...do the normal thing
387
return session.peer_certificate
388
list_size = ctypes.c_uint()
389
cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
390
(session._c_object, ctypes.byref(list_size))
391
if list_size.value == 0:
392
return None
393
cert = cert_list[0]
394
return ctypes.string_at(cert.data, cert.size)
395
396
397
def fingerprint(openpgp):
398
"Convert an OpenPGP bytestring to a hexdigit fingerprint string"
399
# New empty GnuTLS certificate
400
crt = gnutls.library.types.gnutls_openpgp_crt_t()
401
gnutls.library.functions.gnutls_openpgp_crt_init\
402
(ctypes.byref(crt))
403
# New GnuTLS "datum" with the OpenPGP public key
404
datum = gnutls.library.types.gnutls_datum_t\
405
(ctypes.cast(ctypes.c_char_p(openpgp),
406
ctypes.POINTER(ctypes.c_ubyte)),
407
ctypes.c_uint(len(openpgp)))
408
# Import the OpenPGP public key into the certificate
409
ret = gnutls.library.functions.gnutls_openpgp_crt_import\
410
(crt,
411
ctypes.byref(datum),
412
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
# New buffer for the fingerprint
414
buffer = ctypes.create_string_buffer(20)
415
buffer_length = ctypes.c_size_t()
416
# Get the fingerprint from the certificate into the buffer
417
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
418
(crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
419
# Deinit the certificate
420
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
421
# Convert the buffer to a Python bytestring
422
fpr = ctypes.string_at(buffer, buffer_length.value)
423
# Convert the bytestring to hexadecimal notation
424
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
425
return hex_fpr
426
427
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
429
"""A TCP request handler class.
430
Instantiated by IPv6_TCPServer for each request to handle it.
1639
431
Note: This will run in its own forked process."""
1640
432
1641
433
def handle(self):
1642
with contextlib.closing(self.server.child_pipe) as child_pipe:
1643
logger.info("TCP connection from: %s",
1644
unicode(self.client_address))
1645
logger.debug("Pipe FD: %d",
1646
self.server.child_pipe.fileno())
1647
1648
session = (gnutls.connection
1649
.ClientSession(self.request,
1650
gnutls.connection
1651
.X509Credentials()))
1652
1653
# Note: gnutls.connection.X509Credentials is really a
1654
# generic GnuTLS certificate credentials object so long as
1655
# no X.509 keys are added to it. Therefore, we can use it
1656
# here despite using OpenPGP certificates.
1657
1658
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1659
# "+AES-256-CBC", "+SHA1",
1660
# "+COMP-NULL", "+CTYPE-OPENPGP",
1661
# "+DHE-DSS"))
1662
# Use a fallback default, since this MUST be set.
1663
priority = self.server.gnutls_priority
1664
if priority is None:
1665
priority = "NORMAL"
1666
(gnutls.library.functions
1667
.gnutls_priority_set_direct(session._c_object,
1668
priority, None))
1669
1670
# Start communication using the Mandos protocol
1671
# Get protocol number
1672
line = self.request.makefile().readline()
1673
logger.debug("Protocol version: %r", line)
1674
try:
1675
if int(line.strip().split()[0]) > 1:
1676
raise RuntimeError
1677
except (ValueError, IndexError, RuntimeError) as error:
1678
logger.error("Unknown protocol version: %s", error)
1679
return
1680
1681
# Start GnuTLS connection
1682
try:
1683
session.handshake()
1684
except gnutls.errors.GNUTLSError as error:
1685
logger.warning("Handshake failed: %s", error)
1686
# Do not run session.bye() here: the session is not
1687
# established. Just abandon the request.
1688
return
1689
logger.debug("Handshake succeeded")
1690
1691
approval_required = False
1692
try:
1693
try:
1694
fpr = self.fingerprint(self.peer_certificate
1695
(session))
1696
except (TypeError,
1697
gnutls.errors.GNUTLSError) as error:
1698
logger.warning("Bad certificate: %s", error)
1699
return
1700
logger.debug("Fingerprint: %s", fpr)
1701
1702
try:
1703
client = ProxyClient(child_pipe, fpr,
1704
self.client_address)
1705
except KeyError:
1706
return
1707
1708
if client.approval_delay:
1709
delay = client.approval_delay
1710
client.approvals_pending += 1
1711
approval_required = True
1712
1713
while True:
1714
if not client.enabled:
1715
logger.info("Client %s is disabled",
1716
client.name)
1717
if self.server.use_dbus:
1718
# Emit D-Bus signal
1719
client.Rejected("Disabled")
1720
return
1721
1722
if client.approved or not client.approval_delay:
1723
#We are approved or approval is disabled
1724
break
1725
elif client.approved is None:
1726
logger.info("Client %s needs approval",
1727
client.name)
1728
if self.server.use_dbus:
1729
# Emit D-Bus signal
1730
client.NeedApproval(
1731
client.approval_delay_milliseconds(),
1732
client.approved_by_default)
1733
else:
1734
logger.warning("Client %s was not approved",
1735
client.name)
1736
if self.server.use_dbus:
1737
# Emit D-Bus signal
1738
client.Rejected("Denied")
1739
return
1740
1741
#wait until timeout or approved
1742
time = datetime.datetime.now()
1743
client.changedstate.acquire()
1744
client.changedstate.wait(
1745
float(timedelta_to_milliseconds(delay)
1746
/ 1000))
1747
client.changedstate.release()
1748
time2 = datetime.datetime.now()
1749
if (time2 - time) >= delay:
1750
if not client.approved_by_default:
1751
logger.warning("Client %s timed out while"
1752
" waiting for approval",
1753
client.name)
1754
if self.server.use_dbus:
1755
# Emit D-Bus signal
1756
client.Rejected("Approval timed out")
1757
return
1758
else:
1759
break
1760
else:
1761
delay -= time2 - time
1762
1763
sent_size = 0
1764
while sent_size < len(client.secret):
1765
try:
1766
sent = session.send(client.secret[sent_size:])
1767
except gnutls.errors.GNUTLSError as error:
1768
logger.warning("gnutls send failed",
1769
exc_info=error)
1770
return
1771
logger.debug("Sent: %d, remaining: %d",
1772
sent, len(client.secret)
1773
- (sent_size + sent))
1774
sent_size += sent
1775
1776
logger.info("Sending secret to %s", client.name)
1777
# bump the timeout using extended_timeout
1778
client.bump_timeout(client.extended_timeout)
1779
if self.server.use_dbus:
1780
# Emit D-Bus signal
1781
client.GotSecret()
1782
1783
finally:
1784
if approval_required:
1785
client.approvals_pending -= 1
1786
try:
1787
session.bye()
1788
except gnutls.errors.GNUTLSError as error:
1789
logger.warning("GnuTLS bye failed",
1790
exc_info=error)
1791
1792
@staticmethod
1793
def peer_certificate(session):
1794
"Return the peer's OpenPGP certificate as a bytestring"
1795
# If not an OpenPGP certificate...
1796
if (gnutls.library.functions
1797
.gnutls_certificate_type_get(session._c_object)
1798
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1799
# ...do the normal thing
1800
return session.peer_certificate
1801
list_size = ctypes.c_uint(1)
1802
cert_list = (gnutls.library.functions
1803
.gnutls_certificate_get_peers
1804
(session._c_object, ctypes.byref(list_size)))
1805
if not bool(cert_list) and list_size.value != 0:
1806
raise gnutls.errors.GNUTLSError("error getting peer"
1807
" certificate")
1808
if list_size.value == 0:
1809
return None
1810
cert = cert_list[0]
1811
return ctypes.string_at(cert.data, cert.size)
1812
1813
@staticmethod
1814
def fingerprint(openpgp):
1815
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1816
# New GnuTLS "datum" with the OpenPGP public key
1817
datum = (gnutls.library.types
1818
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1819
ctypes.POINTER
1820
(ctypes.c_ubyte)),
1821
ctypes.c_uint(len(openpgp))))
1822
# New empty GnuTLS certificate
1823
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1824
(gnutls.library.functions
1825
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1826
# Import the OpenPGP public key into the certificate
1827
(gnutls.library.functions
1828
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1829
gnutls.library.constants
1830
.GNUTLS_OPENPGP_FMT_RAW))
1831
# Verify the self signature in the key
1832
crtverify = ctypes.c_uint()
1833
(gnutls.library.functions
1834
.gnutls_openpgp_crt_verify_self(crt, 0,
1835
ctypes.byref(crtverify)))
1836
if crtverify.value != 0:
1837
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1838
raise (gnutls.errors.CertificateSecurityError
1839
("Verify failed"))
1840
# New buffer for the fingerprint
1841
buf = ctypes.create_string_buffer(20)
1842
buf_len = ctypes.c_size_t()
1843
# Get the fingerprint from the certificate into the buffer
1844
(gnutls.library.functions
1845
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1846
ctypes.byref(buf_len)))
1847
# Deinit the certificate
1848
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1849
# Convert the buffer to a Python bytestring
1850
fpr = ctypes.string_at(buf, buf_len.value)
1851
# Convert the bytestring to hexadecimal notation
1852
hex_fpr = binascii.hexlify(fpr).upper()
1853
return hex_fpr
1854
1855
1856
class MultiprocessingMixIn(object):
1857
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1858
def sub_process_main(self, request, address):
1859
try:
1860
self.finish_request(request, address)
1861
except Exception:
1862
self.handle_error(request, address)
1863
self.close_request(request)
1864
1865
def process_request(self, request, address):
1866
"""Start a new process to process the request."""
1867
proc = multiprocessing.Process(target = self.sub_process_main,
1868
args = (request, address))
1869
proc.start()
1870
return proc
1871
1872
1873
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1874
""" adds a pipe to the MixIn """
1875
def process_request(self, request, client_address):
1876
"""Overrides and wraps the original process_request().
1877
1878
This function creates a new pipe in self.pipe
1879
"""
1880
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1881
1882
proc = MultiprocessingMixIn.process_request(self, request,
1883
client_address)
1884
self.child_pipe.close()
1885
self.add_pipe(parent_pipe, proc)
1886
1887
def add_pipe(self, parent_pipe, proc):
1888
"""Dummy function; override as necessary"""
1889
raise NotImplementedError
1890
1891
1892
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1893
socketserver.TCPServer, object):
1894
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1895
434
logger.debug(u"TCP connection from: %s",
435
unicode(self.client_address))
436
session = gnutls.connection.ClientSession\
437
(self.request, gnutls.connection.X509Credentials())
438
439
line = self.request.makefile().readline()
440
logger.debug(u"Protocol version: %r", line)
441
try:
442
if int(line.strip().split()[0]) > 1:
443
raise RuntimeError
444
except (ValueError, IndexError, RuntimeError), error:
445
logger.error(u"Unknown protocol version: %s", error)
446
return
447
448
# Note: gnutls.connection.X509Credentials is really a generic
449
# GnuTLS certificate credentials object so long as no X.509
450
# keys are added to it. Therefore, we can use it here despite
451
# using OpenPGP certificates.
452
453
#priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
454
# "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
455
# "+DHE-DSS"))
456
priority = "NORMAL" # Fallback default, since this
457
# MUST be set.
458
if self.server.settings["priority"]:
459
priority = self.server.settings["priority"]
460
gnutls.library.functions.gnutls_priority_set_direct\
461
(session._c_object, priority, None);
462
463
try:
464
session.handshake()
465
except gnutls.errors.GNUTLSError, error:
466
logger.debug(u"Handshake failed: %s", error)
467
# Do not run session.bye() here: the session is not
468
# established. Just abandon the request.
469
return
470
try:
471
fpr = fingerprint(peer_certificate(session))
472
except (TypeError, gnutls.errors.GNUTLSError), error:
473
logger.debug(u"Bad certificate: %s", error)
474
session.bye()
475
return
476
logger.debug(u"Fingerprint: %s", fpr)
477
client = None
478
for c in self.server.clients:
479
if c.fingerprint == fpr:
480
client = c
481
break
482
if not client:
483
logger.debug(u"Client not found for fingerprint: %s", fpr)
484
session.bye()
485
return
486
# Have to check if client.still_valid(), since it is possible
487
# that the client timed out while establishing the GnuTLS
488
# session.
489
if not client.still_valid():
490
logger.debug(u"Client %(name)s is invalid", vars(client))
491
session.bye()
492
return
493
sent_size = 0
494
while sent_size < len(client.secret):
495
sent = session.send(client.secret[sent_size:])
496
logger.debug(u"Sent: %d, remaining: %d",
497
sent, len(client.secret)
498
- (sent_size + sent))
499
sent_size += sent
500
session.bye()
501
502
503
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
504
"""IPv6 TCP server. Accepts 'None' as address and/or port.
1896
505
Attributes:
1897
enabled: Boolean; whether this server is activated yet
1898
interface: None or a network interface name (string)
1899
use_ipv6: Boolean; to use IPv6 or not
506
settings: Server settings
507
clients: Set() of Client objects
1900
508
"""
1901
def __init__(self, server_address, RequestHandlerClass,
1902
interface=None, use_ipv6=True, socketfd=None):
1903
"""If socketfd is set, use that file descriptor instead of
1904
creating a new one with socket.socket().
1905
"""
1906
self.interface = interface
1907
if use_ipv6:
1908
self.address_family = socket.AF_INET6
1909
if socketfd is not None:
1910
# Save the file descriptor
1911
self.socketfd = socketfd
1912
# Save the original socket.socket() function
1913
self.socket_socket = socket.socket
1914
# To implement --socket, we monkey patch socket.socket.
1915
#
1916
# (When socketserver.TCPServer is a new-style class, we
1917
# could make self.socket into a property instead of monkey
1918
# patching socket.socket.)
1919
#
1920
# Create a one-time-only replacement for socket.socket()
1921
@functools.wraps(socket.socket)
1922
def socket_wrapper(*args, **kwargs):
1923
# Restore original function so subsequent calls are
1924
# not affected.
1925
socket.socket = self.socket_socket
1926
del self.socket_socket
1927
# This time only, return a new socket object from the
1928
# saved file descriptor.
1929
return socket.fromfd(self.socketfd, *args, **kwargs)
1930
# Replace socket.socket() function with wrapper
1931
socket.socket = socket_wrapper
1932
# The socketserver.TCPServer.__init__ will call
1933
# socket.socket(), which might be our replacement,
1934
# socket_wrapper(), if socketfd was set.
1935
socketserver.TCPServer.__init__(self, server_address,
1936
RequestHandlerClass)
1937
509
address_family = socket.AF_INET6
510
def __init__(self, *args, **kwargs):
511
if "settings" in kwargs:
512
self.settings = kwargs["settings"]
513
del kwargs["settings"]
514
if "clients" in kwargs:
515
self.clients = kwargs["clients"]
516
del kwargs["clients"]
517
return super(type(self), self).__init__(*args, **kwargs)
1938
518
def server_bind(self):
1939
519
"""This overrides the normal server_bind() function
1940
520
to bind to an interface if one was specified, and also NOT to
1941
521
bind to an address or port if they were not specified."""
1942
if self.interface is not None:
1943
if SO_BINDTODEVICE is None:
1944
logger.error("SO_BINDTODEVICE does not exist;"
1945
" cannot bind to interface %s",
1946
self.interface)
1947
else:
1948
try:
1949
self.socket.setsockopt(socket.SOL_SOCKET,
1950
SO_BINDTODEVICE,
1951
str(self.interface
1952
+ '\0'))
1953
except socket.error as error:
1954
if error.errno == errno.EPERM:
1955
logger.error("No permission to"
1956
" bind to interface %s",
1957
self.interface)
1958
elif error.errno == errno.ENOPROTOOPT:
1959
logger.error("SO_BINDTODEVICE not available;"
1960
" cannot bind to interface %s",
1961
self.interface)
1962
elif error.errno == errno.ENODEV:
1963
logger.error("Interface %s does not"
1964
" exist, cannot bind",
1965
self.interface)
1966
else:
1967
raise
522
if self.settings["interface"]:
523
# 25 is from /usr/include/asm-i486/socket.h
524
SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
525
try:
526
self.socket.setsockopt(socket.SOL_SOCKET,
527
SO_BINDTODEVICE,
528
self.settings["interface"])
529
except socket.error, error:
530
if error[0] == errno.EPERM:
531
logger.warning(u"No permission to"
532
u" bind to interface %s",
533
self.settings["interface"])
534
else:
535
raise error
1968
536
# Only bind(2) the socket if we really need to.
1969
537
if self.server_address[0] or self.server_address[1]:
1970
538
if not self.server_address[0]:
1971
if self.address_family == socket.AF_INET6:
1972
any_address = "::" # in6addr_any
1973
else:
1974
any_address = socket.INADDR_ANY
1975
self.server_address = (any_address,
539
in6addr_any = "::"
540
self.server_address = (in6addr_any,
1976
541
self.server_address[1])
1977
elif not self.server_address[1]:
542
elif self.server_address[1] is None:
1978
543
self.server_address = (self.server_address[0],
1979
544
0)
1980
# if self.interface:
1981
# self.server_address = (self.server_address[0],
1982
# 0, # port
1983
# 0, # flowinfo
1984
# if_nametoindex
1985
# (self.interface))
1986
return socketserver.TCPServer.server_bind(self)
1987
1988
1989
class MandosServer(IPv6_TCPServer):
1990
"""Mandos server.
1991
1992
Attributes:
1993
clients: set of Client objects
1994
gnutls_priority GnuTLS priority string
1995
use_dbus: Boolean; to emit D-Bus signals or not
1996
1997
Assumes a gobject.MainLoop event loop.
1998
"""
1999
def __init__(self, server_address, RequestHandlerClass,
2000
interface=None, use_ipv6=True, clients=None,
2001
gnutls_priority=None, use_dbus=True, socketfd=None):
2002
self.enabled = False
2003
self.clients = clients
2004
if self.clients is None:
2005
self.clients = {}
2006
self.use_dbus = use_dbus
2007
self.gnutls_priority = gnutls_priority
2008
IPv6_TCPServer.__init__(self, server_address,
2009
RequestHandlerClass,
2010
interface = interface,
2011
use_ipv6 = use_ipv6,
2012
socketfd = socketfd)
2013
def server_activate(self):
2014
if self.enabled:
2015
return socketserver.TCPServer.server_activate(self)
2016
2017
def enable(self):
2018
self.enabled = True
2019
2020
def add_pipe(self, parent_pipe, proc):
2021
# Call "handle_ipc" for both data and EOF events
2022
gobject.io_add_watch(parent_pipe.fileno(),
2023
gobject.IO_IN | gobject.IO_HUP,
2024
functools.partial(self.handle_ipc,
2025
parent_pipe =
2026
parent_pipe,
2027
proc = proc))
2028
2029
def handle_ipc(self, source, condition, parent_pipe=None,
2030
proc = None, client_object=None):
2031
# error, or the other end of multiprocessing.Pipe has closed
2032
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2033
# Wait for other process to exit
2034
proc.join()
2035
return False
2036
2037
# Read a request from the child
2038
request = parent_pipe.recv()
2039
command = request[0]
2040
2041
if command == 'init':
2042
fpr = request[1]
2043
address = request[2]
2044
2045
for c in self.clients.itervalues():
2046
if c.fingerprint == fpr:
2047
client = c
2048
break
2049
else:
2050
logger.info("Client not found for fingerprint: %s, ad"
2051
"dress: %s", fpr, address)
2052
if self.use_dbus:
2053
# Emit D-Bus signal
2054
mandos_dbus_service.ClientNotFound(fpr,
2055
address[0])
2056
parent_pipe.send(False)
2057
return False
2058
2059
gobject.io_add_watch(parent_pipe.fileno(),
2060
gobject.IO_IN | gobject.IO_HUP,
2061
functools.partial(self.handle_ipc,
2062
parent_pipe =
2063
parent_pipe,
2064
proc = proc,
2065
client_object =
2066
client))
2067
parent_pipe.send(True)
2068
# remove the old hook in favor of the new above hook on
2069
# same fileno
2070
return False
2071
if command == 'funcall':
2072
funcname = request[1]
2073
args = request[2]
2074
kwargs = request[3]
2075
2076
parent_pipe.send(('data', getattr(client_object,
2077
funcname)(*args,
2078
**kwargs)))
2079
2080
if command == 'getattr':
2081
attrname = request[1]
2082
if callable(client_object.__getattribute__(attrname)):
2083
parent_pipe.send(('function',))
2084
else:
2085
parent_pipe.send(('data', client_object
2086
.__getattribute__(attrname)))
2087
2088
if command == 'setattr':
2089
attrname = request[1]
2090
value = request[2]
2091
setattr(client_object, attrname, value)
2092
2093
return True
545
return super(type(self), self).server_bind()
2094
546
2095
547
2096
548
def string_to_delta(interval):
2097
549
"""Parse a string and return a datetime.timedelta
2098
550
2099
551
>>> string_to_delta('7d')
2100
552
datetime.timedelta(7)
2101
553
>>> string_to_delta('60s')
2104
556
datetime.timedelta(0, 3600)
2105
557
>>> string_to_delta('24h')
2106
558
datetime.timedelta(1)
2107
>>> string_to_delta('1w')
559
>>> string_to_delta(u'1w')
2108
560
datetime.timedelta(7)
2109
>>> string_to_delta('5m 30s')
2110
datetime.timedelta(0, 330)
2111
561
"""
2112
timevalue = datetime.timedelta(0)
2113
for s in interval.split():
2114
try:
2115
suffix = unicode(s[-1])
2116
value = int(s[:-1])
2117
if suffix == "d":
2118
delta = datetime.timedelta(value)
2119
elif suffix == "s":
2120
delta = datetime.timedelta(0, value)
2121
elif suffix == "m":
2122
delta = datetime.timedelta(0, 0, 0, 0, value)
2123
elif suffix == "h":
2124
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2125
elif suffix == "w":
2126
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2127
else:
2128
raise ValueError("Unknown suffix {0!r}"
2129
.format(suffix))
2130
except (ValueError, IndexError) as e:
2131
raise ValueError(*(e.args))
2132
timevalue += delta
2133
return timevalue
2134
2135
2136
def daemon(nochdir = False, noclose = False):
562
try:
563
suffix=unicode(interval[-1])
564
value=int(interval[:-1])
565
if suffix == u"d":
566
delta = datetime.timedelta(value)
567
elif suffix == u"s":
568
delta = datetime.timedelta(0, value)
569
elif suffix == u"m":
570
delta = datetime.timedelta(0, 0, 0, 0, value)
571
elif suffix == u"h":
572
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
573
elif suffix == u"w":
574
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
575
else:
576
raise ValueError
577
except (ValueError, IndexError):
578
raise ValueError
579
return delta
580
581
582
def server_state_changed(state):
583
"""Derived from the Avahi example code"""
584
if state == avahi.SERVER_COLLISION:
585
logger.warning(u"Server name collision")
586
service.remove()
587
elif state == avahi.SERVER_RUNNING:
588
service.add()
589
590
591
def entry_group_state_changed(state, error):
592
"""Derived from the Avahi example code"""
593
logger.debug(u"state change: %i", state)
594
595
if state == avahi.ENTRY_GROUP_ESTABLISHED:
596
logger.debug(u"Service established.")
597
elif state == avahi.ENTRY_GROUP_COLLISION:
598
logger.warning(u"Service name collision.")
599
service.rename()
600
elif state == avahi.ENTRY_GROUP_FAILURE:
601
logger.critical(u"Error in group state changed %s",
602
unicode(error))
603
raise AvahiGroupError("State changed: %s", str(error))
604
605
def if_nametoindex(interface):
606
"""Call the C function if_nametoindex(), or equivalent"""
607
global if_nametoindex
608
try:
609
if "ctypes.util" not in sys.modules:
610
import ctypes.util
611
if_nametoindex = ctypes.cdll.LoadLibrary\
612
(ctypes.util.find_library("c")).if_nametoindex
613
except (OSError, AttributeError):
614
if "struct" not in sys.modules:
615
import struct
616
if "fcntl" not in sys.modules:
617
import fcntl
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
621
s = socket.socket()
622
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
623
struct.pack("16s16x", interface))
624
s.close()
625
interface_index = struct.unpack("I", ifreq[16:20])[0]
626
return interface_index
627
return if_nametoindex(interface)
628
629
630
def daemon(nochdir, noclose):
2137
631
"""See daemon(3). Standard BSD Unix function.
2138
2139
632
This should really exist as os.daemon, but it doesn't (yet)."""
2140
633
if os.fork():
2141
634
sys.exit()
2142
635
os.setsid()
2143
636
if not nochdir:
2144
637
os.chdir("/")
2145
if os.fork():
2146
sys.exit()
2147
638
if not noclose:
2148
639
# Close all standard open file descriptors
2149
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
640
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2150
641
if not stat.S_ISCHR(os.fstat(null).st_mode):
2151
642
raise OSError(errno.ENODEV,
2152
"{0} not a character device"
2153
.format(os.devnull))
643
"/dev/null not a character device")
2154
644
os.dup2(null, sys.stdin.fileno())
2155
645
os.dup2(null, sys.stdout.fileno())
2156
646
os.dup2(null, sys.stderr.fileno())
2159
649
2160
650
2161
651
def main():
2162
2163
##################################################################
2164
# Parsing of options, both command line and config file
2165
2166
parser = argparse.ArgumentParser()
2167
parser.add_argument("-v", "--version", action="version",
2168
version = "%(prog)s {0}".format(version),
2169
help="show version number and exit")
2170
parser.add_argument("-i", "--interface", metavar="IF",
2171
help="Bind to interface IF")
2172
parser.add_argument("-a", "--address",
2173
help="Address to listen for requests on")
2174
parser.add_argument("-p", "--port", type=int,
2175
help="Port number to receive requests on")
2176
parser.add_argument("--check", action="store_true",
2177
help="Run self-test")
2178
parser.add_argument("--debug", action="store_true",
2179
help="Debug mode; run in foreground and log"
2180
" to terminal")
2181
parser.add_argument("--debuglevel", metavar="LEVEL",
2182
help="Debug level for stdout output")
2183
parser.add_argument("--priority", help="GnuTLS"
2184
" priority string (see GnuTLS documentation)")
2185
parser.add_argument("--servicename",
2186
metavar="NAME", help="Zeroconf service name")
2187
parser.add_argument("--configdir",
2188
default="/etc/mandos", metavar="DIR",
2189
help="Directory to search for configuration"
2190
" files")
2191
parser.add_argument("--no-dbus", action="store_false",
2192
dest="use_dbus", help="Do not provide D-Bus"
2193
" system bus interface")
2194
parser.add_argument("--no-ipv6", action="store_false",
2195
dest="use_ipv6", help="Do not use IPv6")
2196
parser.add_argument("--no-restore", action="store_false",
2197
dest="restore", help="Do not restore stored"
2198
" state")
2199
parser.add_argument("--socket", type=int,
2200
help="Specify a file descriptor to a network"
2201
" socket to use instead of creating one")
2202
parser.add_argument("--statedir", metavar="DIR",
2203
help="Directory to save/restore state in")
2204
2205
options = parser.parse_args()
652
global main_loop_started
653
main_loop_started = False
654
655
parser = OptionParser()
656
parser.add_option("-i", "--interface", type="string",
657
metavar="IF", help="Bind to interface IF")
658
parser.add_option("-a", "--address", type="string",
659
help="Address to listen for requests on")
660
parser.add_option("-p", "--port", type="int",
661
help="Port number to receive requests on")
662
parser.add_option("--check", action="store_true", default=False,
663
help="Run self-test")
664
parser.add_option("--debug", action="store_true", default=False,
665
help="Debug mode; run in foreground and log to"
666
" terminal")
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"
674
" files")
675
(options, args) = parser.parse_args()
2206
676
2207
677
if options.check:
2208
678
import doctest
2217
687
"priority":
2218
688
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2219
689
"servicename": "Mandos",
2220
"use_dbus": "True",
2221
"use_ipv6": "True",
2222
"debuglevel": "",
2223
"restore": "True",
2224
"socket": "",
2225
"statedir": "/var/lib/mandos"
2226
690
}
2227
691
2228
692
# Parse config file for server-global settings
2229
server_config = configparser.SafeConfigParser(server_defaults)
693
server_config = ConfigParser.SafeConfigParser(server_defaults)
2230
694
del server_defaults
2231
server_config.read(os.path.join(options.configdir,
2232
"mandos.conf"))
695
server_config.read(os.path.join(options.configdir, "server.conf"))
696
server_section = "server"
2233
697
# Convert the SafeConfigParser object to a dict
2234
server_settings = server_config.defaults()
2235
# Use the appropriate methods on the non-string config options
2236
for option in ("debug", "use_dbus", "use_ipv6"):
2237
server_settings[option] = server_config.getboolean("DEFAULT",
2238
option)
2239
if server_settings["port"]:
2240
server_settings["port"] = server_config.getint("DEFAULT",
2241
"port")
2242
if server_settings["socket"]:
2243
server_settings["socket"] = server_config.getint("DEFAULT",
2244
"socket")
2245
# Later, stdin will, and stdout and stderr might, be dup'ed
2246
# over with an opened os.devnull. But we don't want this to
2247
# happen with a supplied network socket.
2248
if 0 <= server_settings["socket"] <= 2:
2249
server_settings["socket"] = os.dup(server_settings
2250
["socket"])
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")
2251
702
del server_config
2252
703
2253
704
# Override the settings from the config file with command line
2254
705
# options, if set.
2255
706
for option in ("interface", "address", "port", "debug",
2256
"priority", "servicename", "configdir",
2257
"use_dbus", "use_ipv6", "debuglevel", "restore",
2258
"statedir", "socket"):
707
"priority", "servicename", "configdir"):
2259
708
value = getattr(options, option)
2260
709
if value is not None:
2261
710
server_settings[option] = value
2262
711
del options
2263
# Force all strings to be unicode
2264
for option in server_settings.keys():
2265
if type(server_settings[option]) is str:
2266
server_settings[option] = unicode(server_settings[option])
2267
712
# Now we have our good server settings in "server_settings"
2268
713
2269
##################################################################
2270
2271
# For convenience
2272
debug = server_settings["debug"]
2273
debuglevel = server_settings["debuglevel"]
2274
use_dbus = server_settings["use_dbus"]
2275
use_ipv6 = server_settings["use_ipv6"]
2276
stored_state_path = os.path.join(server_settings["statedir"],
2277
stored_state_file)
2278
2279
if debug:
2280
initlogger(debug, logging.DEBUG)
2281
else:
2282
if not debuglevel:
2283
initlogger(debug)
2284
else:
2285
level = getattr(logging, debuglevel.upper())
2286
initlogger(debug, level)
2287
2288
if server_settings["servicename"] != "Mandos":
2289
syslogger.setFormatter(logging.Formatter
2290
('Mandos ({0}) [%(process)d]:'
2291
' %(levelname)s: %(message)s'
2292
.format(server_settings
2293
["servicename"])))
2294
2295
714
# Parse config file with clients
2296
client_config = configparser.SafeConfigParser(Client
2297
.client_defaults)
715
client_defaults = { "timeout": "1h",
716
"interval": "5m",
717
"checker": "fping -q -- %%(fqdn)s",
718
}
719
client_config = ConfigParser.SafeConfigParser(client_defaults)
2298
720
client_config.read(os.path.join(server_settings["configdir"],
2299
721
"clients.conf"))
2300
722
2301
global mandos_dbus_service
2302
mandos_dbus_service = None
2303
2304
tcp_server = MandosServer((server_settings["address"],
2305
server_settings["port"]),
2306
ClientHandler,
2307
interface=(server_settings["interface"]
2308
or None),
2309
use_ipv6=use_ipv6,
2310
gnutls_priority=
2311
server_settings["priority"],
2312
use_dbus=use_dbus,
2313
socketfd=(server_settings["socket"]
2314
or None))
2315
if not debug:
2316
pidfilename = "/var/run/mandos.pid"
2317
try:
2318
pidfile = open(pidfilename, "w")
2319
except IOError as e:
2320
logger.error("Could not open file %r", pidfilename,
2321
exc_info=e)
2322
2323
for name in ("_mandos", "mandos", "nobody"):
2324
try:
2325
uid = pwd.getpwnam(name).pw_uid
2326
gid = pwd.getpwnam(name).pw_gid
2327
break
2328
except KeyError:
2329
continue
2330
else:
2331
uid = 65534
2332
gid = 65534
2333
try:
2334
os.setgid(gid)
2335
os.setuid(uid)
2336
except OSError as error:
2337
if error.errno != errno.EPERM:
2338
raise error
2339
2340
if debug:
2341
# Enable all possible GnuTLS debugging
2342
2343
# "Use a log level over 10 to enable all debugging options."
2344
# - GnuTLS manual
2345
gnutls.library.functions.gnutls_global_set_log_level(11)
2346
2347
@gnutls.library.types.gnutls_log_func
2348
def debug_gnutls(level, string):
2349
logger.debug("GnuTLS: %s", string[:-1])
2350
2351
(gnutls.library.functions
2352
.gnutls_global_set_log_function(debug_gnutls))
2353
2354
# Redirect stdin so all checkers get /dev/null
2355
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2356
os.dup2(null, sys.stdin.fileno())
2357
if null > 2:
2358
os.close(null)
2359
2360
# Need to fork before connecting to D-Bus
2361
if not debug:
2362
# Close all input and output, do double fork, etc.
2363
daemon()
2364
2365
# multiprocessing will use threads, so before we use gobject we
2366
# need to inform gobject that threads will be used.
2367
gobject.threads_init()
723
global service
724
service = AvahiService(name = server_settings["servicename"],
725
type = "_mandos._tcp", );
726
if server_settings["interface"]:
727
service.interface = if_nametoindex(server_settings["interface"])
2368
728
2369
729
global main_loop
730
global bus
731
global server
2370
732
# From the Avahi example code
2371
DBusGMainLoop(set_as_default=True)
733
DBusGMainLoop(set_as_default=True )
2372
734
main_loop = gobject.MainLoop()
2373
735
bus = dbus.SystemBus()
736
server = dbus.Interface(
737
bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
738
avahi.DBUS_INTERFACE_SERVER )
2374
739
# End of Avahi example code
2375
if use_dbus:
2376
try:
2377
bus_name = dbus.service.BusName("se.recompile.Mandos",
2378
bus, do_not_queue=True)
2379
old_bus_name = (dbus.service.BusName
2380
("se.bsnet.fukt.Mandos", bus,
2381
do_not_queue=True))
2382
except dbus.exceptions.NameExistsException as e:
2383
logger.error("Disabling D-Bus:", exc_info=e)
2384
use_dbus = False
2385
server_settings["use_dbus"] = False
2386
tcp_server.use_dbus = False
2387
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2388
service = AvahiServiceToSyslog(name =
2389
server_settings["servicename"],
2390
servicetype = "_mandos._tcp",
2391
protocol = protocol, bus = bus)
2392
if server_settings["interface"]:
2393
service.interface = (if_nametoindex
2394
(str(server_settings["interface"])))
2395
2396
global multiprocessing_manager
2397
multiprocessing_manager = multiprocessing.Manager()
2398
2399
client_class = Client
2400
if use_dbus:
2401
client_class = functools.partial(ClientDBus, bus = bus)
2402
2403
client_settings = Client.config_parser(client_config)
2404
old_client_settings = {}
2405
clients_data = {}
2406
2407
# Get client data and settings from last running state.
2408
if server_settings["restore"]:
2409
try:
2410
with open(stored_state_path, "rb") as stored_state:
2411
clients_data, old_client_settings = (pickle.load
2412
(stored_state))
2413
os.remove(stored_state_path)
2414
except IOError as e:
2415
if e.errno == errno.ENOENT:
2416
logger.warning("Could not load persistent state: {0}"
2417
.format(os.strerror(e.errno)))
2418
else:
2419
logger.critical("Could not load persistent state:",
2420
exc_info=e)
2421
raise
2422
except EOFError as e:
2423
logger.warning("Could not load persistent state: "
2424
"EOFError:", exc_info=e)
2425
2426
with PGPEngine() as pgp:
2427
for client_name, client in clients_data.iteritems():
2428
# Decide which value to use after restoring saved state.
2429
# We have three different values: Old config file,
2430
# new config file, and saved state.
2431
# New config value takes precedence if it differs from old
2432
# config value, otherwise use saved state.
2433
for name, value in client_settings[client_name].items():
2434
try:
2435
# For each value in new config, check if it
2436
# differs from the old config value (Except for
2437
# the "secret" attribute)
2438
if (name != "secret" and
2439
value != old_client_settings[client_name]
2440
[name]):
2441
client[name] = value
2442
except KeyError:
2443
pass
2444
2445
# Clients who has passed its expire date can still be
2446
# enabled if its last checker was successful. Clients
2447
# whose checker succeeded before we stored its state is
2448
# assumed to have successfully run all checkers during
2449
# downtime.
2450
if client["enabled"]:
2451
if datetime.datetime.utcnow() >= client["expires"]:
2452
if not client["last_checked_ok"]:
2453
logger.warning(
2454
"disabling client {0} - Client never "
2455
"performed a successful checker"
2456
.format(client_name))
2457
client["enabled"] = False
2458
elif client["last_checker_status"] != 0:
2459
logger.warning(
2460
"disabling client {0} - Client "
2461
"last checker failed with error code {1}"
2462
.format(client_name,
2463
client["last_checker_status"]))
2464
client["enabled"] = False
2465
else:
2466
client["expires"] = (datetime.datetime
2467
.utcnow()
2468
+ client["timeout"])
2469
logger.debug("Last checker succeeded,"
2470
" keeping {0} enabled"
2471
.format(client_name))
2472
try:
2473
client["secret"] = (
2474
pgp.decrypt(client["encrypted_secret"],
2475
client_settings[client_name]
2476
["secret"]))
2477
except PGPError:
2478
# If decryption fails, we use secret from new settings
2479
logger.debug("Failed to decrypt {0} old secret"
2480
.format(client_name))
2481
client["secret"] = (
2482
client_settings[client_name]["secret"])
2483
2484
# Add/remove clients based on new changes made to config
2485
for client_name in (set(old_client_settings)
2486
- set(client_settings)):
2487
del clients_data[client_name]
2488
for client_name in (set(client_settings)
2489
- set(old_client_settings)):
2490
clients_data[client_name] = client_settings[client_name]
2491
2492
# Create all client objects
2493
for client_name, client in clients_data.iteritems():
2494
tcp_server.clients[client_name] = client_class(
2495
name = client_name, settings = client)
2496
2497
if not tcp_server.clients:
2498
logger.warning("No clients defined")
740
741
debug = server_settings["debug"]
742
743
if debug:
744
console = logging.StreamHandler()
745
# console.setLevel(logging.DEBUG)
746
console.setFormatter(logging.Formatter\
747
('%(levelname)s: %(message)s'))
748
logger.addHandler(console)
749
del console
750
751
clients = Set()
752
def remove_from_clients(client):
753
clients.remove(client)
754
if not clients:
755
logger.debug(u"No clients left, exiting")
756
sys.exit()
757
758
clients.update(Set(Client(name=section,
759
stop_hook = remove_from_clients,
760
**(dict(client_config\
761
.items(section))))
762
for section in client_config.sections()))
2499
763
2500
764
if not debug:
2501
try:
2502
with pidfile:
2503
pid = os.getpid()
2504
pidfile.write(str(pid) + "\n".encode("utf-8"))
2505
del pidfile
2506
except IOError:
2507
logger.error("Could not write to file %r with PID %d",
2508
pidfilename, pid)
2509
except NameError:
2510
# "pidfile" was never created
2511
pass
2512
del pidfilename
2513
2514
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2515
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2516
2517
if use_dbus:
2518
@alternate_dbus_interfaces({"se.recompile.Mandos":
2519
"se.bsnet.fukt.Mandos"})
2520
class MandosDBusService(DBusObjectWithProperties):
2521
"""A D-Bus proxy object"""
2522
def __init__(self):
2523
dbus.service.Object.__init__(self, bus, "/")
2524
_interface = "se.recompile.Mandos"
2525
2526
@dbus_interface_annotations(_interface)
2527
def _foo(self):
2528
return { "org.freedesktop.DBus.Property"
2529
".EmitsChangedSignal":
2530
"false"}
2531
2532
@dbus.service.signal(_interface, signature="o")
2533
def ClientAdded(self, objpath):
2534
"D-Bus signal"
2535
pass
2536
2537
@dbus.service.signal(_interface, signature="ss")
2538
def ClientNotFound(self, fingerprint, address):
2539
"D-Bus signal"
2540
pass
2541
2542
@dbus.service.signal(_interface, signature="os")
2543
def ClientRemoved(self, objpath, name):
2544
"D-Bus signal"
2545
pass
2546
2547
@dbus.service.method(_interface, out_signature="ao")
2548
def GetAllClients(self):
2549
"D-Bus method"
2550
return dbus.Array(c.dbus_object_path
2551
for c in
2552
tcp_server.clients.itervalues())
2553
2554
@dbus.service.method(_interface,
2555
out_signature="a{oa{sv}}")
2556
def GetAllClientsWithProperties(self):
2557
"D-Bus method"
2558
return dbus.Dictionary(
2559
((c.dbus_object_path, c.GetAll(""))
2560
for c in tcp_server.clients.itervalues()),
2561
signature="oa{sv}")
2562
2563
@dbus.service.method(_interface, in_signature="o")
2564
def RemoveClient(self, object_path):
2565
"D-Bus method"
2566
for c in tcp_server.clients.itervalues():
2567
if c.dbus_object_path == object_path:
2568
del tcp_server.clients[c.name]
2569
c.remove_from_connection()
2570
# Don't signal anything except ClientRemoved
2571
c.disable(quiet=True)
2572
# Emit D-Bus signal
2573
self.ClientRemoved(object_path, c.name)
2574
return
2575
raise KeyError(object_path)
2576
2577
del _interface
2578
2579
mandos_dbus_service = MandosDBusService()
765
daemon(False, False)
2580
766
2581
767
def cleanup():
2582
768
"Cleanup function; run on exit"
2583
service.cleanup()
2584
2585
multiprocessing.active_children()
2586
if not (tcp_server.clients or client_settings):
2587
return
2588
2589
# Store client before exiting. Secrets are encrypted with key
2590
# based on what config file has. If config file is
2591
# removed/edited, old secret will thus be unrecovable.
2592
clients = {}
2593
with PGPEngine() as pgp:
2594
for client in tcp_server.clients.itervalues():
2595
key = client_settings[client.name]["secret"]
2596
client.encrypted_secret = pgp.encrypt(client.secret,
2597
key)
2598
client_dict = {}
2599
2600
# A list of attributes that can not be pickled
2601
# + secret.
2602
exclude = set(("bus", "changedstate", "secret",
2603
"checker"))
2604
for name, typ in (inspect.getmembers
2605
(dbus.service.Object)):
2606
exclude.add(name)
2607
2608
client_dict["encrypted_secret"] = (client
2609
.encrypted_secret)
2610
for attr in client.client_structure:
2611
if attr not in exclude:
2612
client_dict[attr] = getattr(client, attr)
2613
2614
clients[client.name] = client_dict
2615
del client_settings[client.name]["secret"]
2616
2617
try:
2618
with (tempfile.NamedTemporaryFile
2619
(mode='wb', suffix=".pickle", prefix='clients-',
2620
dir=os.path.dirname(stored_state_path),
2621
delete=False)) as stored_state:
2622
pickle.dump((clients, client_settings), stored_state)
2623
tempname=stored_state.name
2624
os.rename(tempname, stored_state_path)
2625
except (IOError, OSError) as e:
2626
if not debug:
2627
try:
2628
os.remove(tempname)
2629
except NameError:
2630
pass
2631
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2632
logger.warning("Could not save persistent state: {0}"
2633
.format(os.strerror(e.errno)))
2634
else:
2635
logger.warning("Could not save persistent state:",
2636
exc_info=e)
2637
raise e
2638
2639
# Delete all clients, and settings from config
2640
while tcp_server.clients:
2641
name, client = tcp_server.clients.popitem()
2642
if use_dbus:
2643
client.remove_from_connection()
2644
# Don't signal anything except ClientRemoved
2645
client.disable(quiet=True)
2646
if use_dbus:
2647
# Emit D-Bus signal
2648
mandos_dbus_service.ClientRemoved(client
2649
.dbus_object_path,
2650
client.name)
2651
client_settings.clear()
769
global group
770
# From the Avahi example code
771
if not group is None:
772
group.Free()
773
group = None
774
# End of Avahi example code
775
776
while clients:
777
client = clients.pop()
778
client.stop_hook = None
779
client.stop()
2652
780
2653
781
atexit.register(cleanup)
2654
782
2655
for client in tcp_server.clients.itervalues():
2656
if use_dbus:
2657
# Emit D-Bus signal
2658
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2659
# Need to initiate checking of clients
2660
if client.enabled:
2661
client.init_checker()
2662
2663
tcp_server.enable()
2664
tcp_server.server_activate()
2665
783
if not debug:
784
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())
787
788
for client in clients:
789
client.start()
790
791
tcp_server = IPv6_TCPServer((server_settings["address"],
792
server_settings["port"]),
793
tcp_handler,
794
settings=server_settings,
795
clients=clients)
2666
796
# Find out what port we got
2667
797
service.port = tcp_server.socket.getsockname()[1]
2668
if use_ipv6:
2669
logger.info("Now listening on address %r, port %d,"
2670
" flowinfo %d, scope_id %d",
2671
*tcp_server.socket.getsockname())
2672
else: # IPv4
2673
logger.info("Now listening on address %r, port %d",
2674
*tcp_server.socket.getsockname())
798
logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
799
u" scope_id %d" % tcp_server.socket.getsockname())
2675
800
2676
801
#service.interface = tcp_server.socket.getsockname()[3]
2677
802
2678
803
try:
2679
804
# From the Avahi example code
805
server.connect_to_signal("StateChanged", server_state_changed)
2680
806
try:
2681
service.activate()
2682
except dbus.exceptions.DBusException as error:
2683
logger.critical("D-Bus Exception", exc_info=error)
2684
cleanup()
807
server_state_changed(server.GetState())
808
except dbus.exceptions.DBusException, error:
809
logger.critical(u"DBusException: %s", error)
2685
810
sys.exit(1)
2686
811
# End of Avahi example code
2687
812
2688
813
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2689
814
lambda *args, **kwargs:
2690
(tcp_server.handle_request
2691
(*args[2:], **kwargs) or True))
815
tcp_server.handle_request\
816
(*args[2:], **kwargs) or True)
2692
817
2693
818
logger.debug("Starting main loop")
819
main_loop_started = True
2694
820
main_loop.run()
2695
except AvahiError as error:
2696
logger.critical("Avahi Error", exc_info=error)
2697
cleanup()
821
except AvahiError, error:
822
logger.critical(u"AvahiError: %s" + unicode(error))
2698
823
sys.exit(1)
2699
824
except KeyboardInterrupt:
2700
825
if debug:
2701
print("", file=sys.stderr)
2702
logger.debug("Server received KeyboardInterrupt")
2703
logger.debug("Server exiting")
2704
# Must run before the D-Bus bus name gets deregistered
2705
cleanup()
826
print
2706
827
2707
828
if __name__ == '__main__':
2708
829
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0