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