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