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:
- debian/mandos-client.examples
- 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.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
91
version = "1.6.2"
92
stored_state_file = "clients.pickle"
93
94
logger = logging.getLogger()
88
95
syslogger = (logging.handlers.SysLogHandler
89
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
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
101
220
102
221
class AvahiError(Exception):
103
222
def __init__(self, value, *args, **kwargs):
119
238
Attributes:
120
239
interface: integer; avahi.IF_UNSPEC or an interface index.
121
240
Used to optionally bind to the specified interface.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
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>
125
244
port: integer; what port to announce
126
245
TXT: list of strings; TXT record for the service
127
246
domain: string; Domain to publish on, default to .local if empty.
133
252
server: D-Bus Server
134
253
bus: dbus.SystemBus()
135
254
"""
255
136
256
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
137
257
servicetype = None, port = None, TXT = None,
138
domain = u"", host = u"", max_renames = 32768,
258
domain = "", host = "", max_renames = 32768,
139
259
protocol = avahi.PROTO_UNSPEC, bus = None):
140
260
self.interface = interface
141
261
self.name = name
150
270
self.group = None # our entry group
151
271
self.server = None
152
272
self.bus = bus
273
self.entry_group_state_changed_match = None
274
153
275
def rename(self):
154
276
"""Derived from the Avahi example code"""
155
277
if self.rename_count >= self.max_renames:
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
278
logger.critical("No suitable Zeroconf service name found"
279
" after %i retries, exiting.",
158
280
self.rename_count)
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
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 ...",
162
285
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
167
286
self.remove()
168
287
try:
169
288
self.add()
170
except dbus.exceptions.DBusException, error:
171
logger.critical(u"DBusException: %s", error)
289
except dbus.exceptions.DBusException as error:
290
logger.critical("D-Bus Exception", exc_info=error)
172
291
self.cleanup()
173
292
os._exit(1)
174
293
self.rename_count += 1
294
175
295
def remove(self):
176
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
177
300
if self.group is not None:
178
301
self.group.Reset()
302
179
303
def add(self):
180
304
"""Derived from the Avahi example code"""
305
self.remove()
181
306
if self.group is None:
182
307
self.group = dbus.Interface(
183
308
self.bus.get_object(avahi.DBUS_NAME,
184
309
self.server.EntryGroupNew()),
185
310
avahi.DBUS_INTERFACE_ENTRY_GROUP)
186
self.group.connect_to_signal('StateChanged',
187
self
188
.entry_group_state_changed)
189
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' ...",
190
315
self.name, self.type)
191
316
self.group.AddService(
192
317
self.interface,
197
322
dbus.UInt16(self.port),
198
323
avahi.string_array_to_txt_array(self.TXT))
199
324
self.group.Commit()
325
200
326
def entry_group_state_changed(self, state, error):
201
327
"""Derived from the Avahi example code"""
202
logger.debug(u"Avahi entry group state change: %i", state)
328
logger.debug("Avahi entry group state change: %i", state)
203
329
204
330
if state == avahi.ENTRY_GROUP_ESTABLISHED:
205
logger.debug(u"Zeroconf service established.")
331
logger.debug("Zeroconf service established.")
206
332
elif state == avahi.ENTRY_GROUP_COLLISION:
207
logger.warning(u"Zeroconf service name collision.")
333
logger.info("Zeroconf service name collision.")
208
334
self.rename()
209
335
elif state == avahi.ENTRY_GROUP_FAILURE:
210
logger.critical(u"Avahi: Error in group state changed %s",
336
logger.critical("Avahi: Error in group state changed %s",
211
337
unicode(error))
212
raise AvahiGroupError(u"State changed: %s"
213
% unicode(error))
338
raise AvahiGroupError("State changed: {0!s}"
339
.format(error))
340
214
341
def cleanup(self):
215
342
"""Derived from the Avahi example code"""
216
343
if self.group is not None:
217
self.group.Free()
344
try:
345
self.group.Free()
346
except (dbus.exceptions.UnknownMethodException,
347
dbus.exceptions.DBusException):
348
pass
218
349
self.group = None
219
def server_state_changed(self, state):
350
self.remove()
351
352
def server_state_changed(self, state, error=None):
220
353
"""Derived from the Avahi example code"""
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
224
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()
225
369
elif state == avahi.SERVER_RUNNING:
226
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
227
377
def activate(self):
228
378
"""Derived from the Avahi example code"""
229
379
if self.server is None:
230
380
self.server = dbus.Interface(
231
381
self.bus.get_object(avahi.DBUS_NAME,
232
avahi.DBUS_PATH_SERVER),
382
avahi.DBUS_PATH_SERVER,
383
follow_name_owner_changes=True),
233
384
avahi.DBUS_INTERFACE_SERVER)
234
self.server.connect_to_signal(u"StateChanged",
385
self.server.connect_to_signal("StateChanged",
235
386
self.server_state_changed)
236
387
self.server_state_changed(self.server.GetState())
237
388
238
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
239
408
class Client(object):
240
409
"""A representation of a client host served by this server.
241
410
242
411
Attributes:
243
_approved: bool(); 'None' if not yet approved/disapproved
412
approved: bool(); 'None' if not yet approved/disapproved
244
413
approval_delay: datetime.timedelta(); Time to wait for approval
245
414
approval_duration: datetime.timedelta(); Duration of one approval
246
415
checker: subprocess.Popen(); a running checker process used
247
416
to see if the client lives.
248
417
'None' if no process is running.
249
checker_callback_tag: - '' -
418
checker_callback_tag: a gobject event source tag, or None
250
419
checker_command: string; External command which is run to check
251
420
if client lives. %() expansions are done at
252
421
runtime with vars(self) as dict, so that for
253
422
instance %(name)s can be used in the command.
254
423
checker_initiator_tag: a gobject event source tag, or None
255
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
256
427
current_checker_command: string; current running checker_command
257
disable_hook: If set, called by disable() as disable_hook(self)
258
disable_initiator_tag: - '' -
428
disable_initiator_tag: a gobject event source tag, or None
259
429
enabled: bool()
260
430
fingerprint: string (40 or 32 hexadecimal digits); used to
261
431
uniquely identify the client
262
432
host: string; available for use by the checker command
263
433
interval: datetime.timedelta(); How often to start a new checker
434
last_approval_request: datetime.datetime(); (UTC) or None
264
435
last_checked_ok: datetime.datetime(); (UTC) or None
265
last_enabled: datetime.datetime(); (UTC)
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
266
440
name: string; from the config file, used in log messages and
267
441
D-Bus identifiers
268
442
secret: bytestring; sent verbatim (over TLS) to client
269
443
timeout: datetime.timedelta(); How long from last_checked_ok
270
444
until this client is disabled
445
extended_timeout: extra long timeout when secret has been sent
271
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()
272
450
"""
273
451
274
runtime_expansions = (u"approval_delay", u"approval_duration",
275
u"created", u"enabled", u"fingerprint",
276
u"host", u"interval", u"last_checked_ok",
277
u"last_enabled", u"name", u"timeout")
278
279
@staticmethod
280
def _timedelta_to_milliseconds(td):
281
"Convert a datetime.timedelta() to milliseconds"
282
return ((td.days * 24 * 60 * 60 * 1000)
283
+ (td.seconds * 1000)
284
+ (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
}
285
467
286
468
def timeout_milliseconds(self):
287
469
"Return the 'timeout' attribute in milliseconds"
288
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)
289
475
290
476
def interval_milliseconds(self):
291
477
"Return the 'interval' attribute in milliseconds"
292
return self._timedelta_to_milliseconds(self.interval)
293
478
return timedelta_to_milliseconds(self.interval)
479
294
480
def approval_delay_milliseconds(self):
295
return self._timedelta_to_milliseconds(self.approval_delay)
296
297
def __init__(self, name = None, disable_hook=None, config=None):
298
"""Note: the 'checker' key in 'config' sets the
299
'checker_command' attribute and *not* the 'checker'
300
attribute."""
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):
301
531
self.name = name
302
if config is None:
303
config = {}
304
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)
305
550
# Uppercase and remove spaces from fingerprint for later
306
551
# comparison purposes with return value from the fingerprint()
307
552
# function
308
self.fingerprint = (config[u"fingerprint"].upper()
309
.replace(u" ", u""))
310
logger.debug(u" Fingerprint: %s", self.fingerprint)
311
if u"secret" in config:
312
self.secret = config[u"secret"].decode(u"base64")
313
elif u"secfile" in config:
314
with open(os.path.expanduser(os.path.expandvars
315
(config[u"secfile"])),
316
"rb") as secfile:
317
self.secret = secfile.read()
318
else:
319
raise TypeError(u"No secret or secfile for client %s"
320
% self.name)
321
self.host = config.get(u"host", u"")
322
self.created = datetime.datetime.utcnow()
323
self.enabled = False
324
self.last_enabled = None
325
self.last_checked_ok = None
326
self.timeout = string_to_delta(config[u"timeout"])
327
self.interval = string_to_delta(config[u"interval"])
328
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
329
558
self.checker = None
330
559
self.checker_initiator_tag = None
331
560
self.disable_initiator_tag = None
332
561
self.checker_callback_tag = None
333
self.checker_command = config[u"checker"]
334
562
self.current_checker_command = None
335
self.last_connect = None
336
self._approved = None
337
self.approved_by_default = config.get(u"approved_by_default",
338
True)
563
self.approved = None
339
564
self.approvals_pending = 0
340
self.approval_delay = string_to_delta(
341
config[u"approval_delay"])
342
self.approval_duration = string_to_delta(
343
config[u"approval_duration"])
344
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
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)
345
579
580
# Send notice to process children that client state has changed
346
581
def send_changedstate(self):
347
self.changedstate.acquire()
348
self.changedstate.notify_all()
349
self.changedstate.release()
350
582
with self.changedstate:
583
self.changedstate.notify_all()
584
351
585
def enable(self):
352
586
"""Start this client's checker and timeout hooks"""
353
if getattr(self, u"enabled", False):
587
if getattr(self, "enabled", False):
354
588
# Already enabled
355
589
return
356
self.send_changedstate()
590
self.expires = datetime.datetime.utcnow() + self.timeout
591
self.enabled = True
357
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):
358
620
# Schedule a new checker to be started an 'interval' from now,
359
621
# and every interval from then on.
622
if self.checker_initiator_tag is not None:
623
gobject.source_remove(self.checker_initiator_tag)
360
624
self.checker_initiator_tag = (gobject.timeout_add
361
625
(self.interval_milliseconds(),
362
626
self.start_checker))
363
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)
364
630
self.disable_initiator_tag = (gobject.timeout_add
365
631
(self.timeout_milliseconds(),
366
632
self.disable))
367
self.enabled = True
368
633
# Also start a new checker *right now*.
369
634
self.start_checker()
370
635
371
def disable(self, quiet=True):
372
"""Disable this client."""
373
if not getattr(self, "enabled", False):
374
return False
375
if not quiet:
376
self.send_changedstate()
377
if not quiet:
378
logger.info(u"Disabling client %s", self.name)
379
if getattr(self, u"disable_initiator_tag", False):
380
gobject.source_remove(self.disable_initiator_tag)
381
self.disable_initiator_tag = None
382
if getattr(self, u"checker_initiator_tag", False):
383
gobject.source_remove(self.checker_initiator_tag)
384
self.checker_initiator_tag = None
385
self.stop_checker()
386
if self.disable_hook:
387
self.disable_hook(self)
388
self.enabled = False
389
# Do not run this again if called by a gobject.timeout_add
390
return False
391
392
def __del__(self):
393
self.disable_hook = None
394
self.disable()
395
396
636
def checker_callback(self, pid, condition, command):
397
637
"""The checker has completed, so take appropriate actions."""
398
638
self.checker_callback_tag = None
399
639
self.checker = None
400
640
if os.WIFEXITED(condition):
401
exitstatus = os.WEXITSTATUS(condition)
402
if exitstatus == 0:
403
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",
404
644
vars(self))
405
645
self.checked_ok()
406
646
else:
407
logger.info(u"Checker for %(name)s failed",
647
logger.info("Checker for %(name)s failed",
408
648
vars(self))
409
649
else:
410
logger.warning(u"Checker for %(name)s crashed?",
650
self.last_checker_status = -1
651
logger.warning("Checker for %(name)s crashed?",
411
652
vars(self))
412
653
413
654
def checked_ok(self):
414
"""Bump up the timeout for this client.
415
416
This should only be called when the client has been seen,
417
alive and well.
418
"""
655
"""Assert that the client has been seen, alive and well."""
419
656
self.last_checked_ok = datetime.datetime.utcnow()
420
gobject.source_remove(self.disable_initiator_tag)
421
self.disable_initiator_tag = (gobject.timeout_add
422
(self.timeout_milliseconds(),
423
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()
424
675
425
676
def start_checker(self):
426
677
"""Start a new checker subprocess if one is not running.
428
679
If a checker already exists, leave it running and do
429
680
nothing."""
430
681
# The reason for not killing a running checker is that if we
431
# did that, then if a checker (for some reason) started
432
# running slowly and taking more than 'interval' time, the
433
# client would inevitably timeout, since no checker would get
434
# 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
435
686
# checkers alone, the checker would have to take more time
436
687
# than 'timeout' for the client to be disabled, which is as it
437
688
# should be.
439
690
# If a checker exists, make sure it is not a zombie
440
691
try:
441
692
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
442
except (AttributeError, OSError), error:
693
except (AttributeError, OSError) as error:
443
694
if (isinstance(error, OSError)
444
695
and error.errno != errno.ECHILD):
445
696
raise error
446
697
else:
447
698
if pid:
448
logger.warning(u"Checker was a zombie")
699
logger.warning("Checker was a zombie")
449
700
gobject.source_remove(self.checker_callback_tag)
450
701
self.checker_callback(pid, status,
451
702
self.current_checker_command)
452
703
# Start a new checker if needed
453
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)
454
710
try:
455
# In case checker_command has exactly one % operator
456
command = self.checker_command % self.host
457
except TypeError:
458
# Escape attributes for the shell
459
escaped_attrs = dict(
460
(attr,
461
re.escape(unicode(str(getattr(self, attr, u"")),
462
errors=
463
u'replace')))
464
for attr in
465
self.runtime_expansions)
466
467
try:
468
command = self.checker_command % escaped_attrs
469
except TypeError, error:
470
logger.error(u'Could not format string "%s":'
471
u' %s', self.checker_command, error)
472
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
473
716
self.current_checker_command = command
474
717
try:
475
logger.info(u"Starting checker %r for %s",
718
logger.info("Starting checker %r for %s",
476
719
command, self.name)
477
720
# We don't need to redirect stdout and stderr, since
478
721
# in normal mode, that is already done by daemon(),
479
722
# and in debug mode we don't want to. (Stdin is
480
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 })
481
732
self.checker = subprocess.Popen(command,
482
733
close_fds=True,
483
shell=True, cwd=u"/")
484
self.checker_callback_tag = (gobject.child_watch_add
485
(self.checker.pid,
486
self.checker_callback,
487
data=command))
488
# The checker may have completed before the gobject
489
# 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:
490
747
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
491
if pid:
492
gobject.source_remove(self.checker_callback_tag)
493
self.checker_callback(pid, status, command)
494
except OSError, error:
495
logger.error(u"Failed to start subprocess: %s",
496
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)
497
758
# Re-run this periodically if run by gobject.timeout_add
498
759
return True
499
760
502
763
if self.checker_callback_tag:
503
764
gobject.source_remove(self.checker_callback_tag)
504
765
self.checker_callback_tag = None
505
if getattr(self, u"checker", None) is None:
766
if getattr(self, "checker", None) is None:
506
767
return
507
logger.debug(u"Stopping checker for %(name)s", vars(self))
768
logger.debug("Stopping checker for %(name)s", vars(self))
508
769
try:
509
os.kill(self.checker.pid, signal.SIGTERM)
770
self.checker.terminate()
510
771
#time.sleep(0.5)
511
772
#if self.checker.poll() is None:
512
# os.kill(self.checker.pid, signal.SIGKILL)
513
except OSError, error:
773
# self.checker.kill()
774
except OSError as error:
514
775
if error.errno != errno.ESRCH: # No such process
515
776
raise
516
777
self.checker = None
517
778
518
def dbus_service_property(dbus_interface, signature=u"v",
519
access=u"readwrite", byte_arrays=False):
779
780
def dbus_service_property(dbus_interface, signature="v",
781
access="readwrite", byte_arrays=False):
520
782
"""Decorators for marking methods of a DBusObjectWithProperties to
521
783
become properties on the D-Bus.
522
784
529
791
"""
530
792
# Encoding deeply encoded byte arrays is not supported yet by the
531
793
# "Set" method, so we fail early here:
532
if byte_arrays and signature != u"ay":
533
raise ValueError(u"Byte arrays not supported for non-'ay'"
534
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))
535
797
def decorator(func):
536
798
func._dbus_is_property = True
537
799
func._dbus_interface = dbus_interface
538
800
func._dbus_signature = signature
539
801
func._dbus_access = access
540
802
func._dbus_name = func.__name__
541
if func._dbus_name.endswith(u"_dbus_property"):
803
if func._dbus_name.endswith("_dbus_property"):
542
804
func._dbus_name = func._dbus_name[:-14]
543
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
544
843
return func
545
844
return decorator
546
845
566
865
567
866
class DBusObjectWithProperties(dbus.service.Object):
568
867
"""A D-Bus object with properties.
569
868
570
869
Classes inheriting from this can use the dbus_service_property
571
870
decorator to expose methods as D-Bus properties. It exposes the
572
871
standard Get(), Set(), and GetAll() methods on the D-Bus.
573
872
"""
574
873
575
874
@staticmethod
576
def _is_dbus_property(obj):
577
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)
578
883
579
def _get_all_dbus_properties(self):
884
def _get_all_dbus_things(self, thing):
580
885
"""Returns a generator of (name, attribute) pairs
581
886
"""
582
return ((prop._dbus_name, prop)
583
for name, prop in
584
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)))
585
894
586
895
def _get_dbus_property(self, interface_name, property_name):
587
896
"""Returns a bound method if one exists which is a D-Bus
588
897
property with the specified name and interface.
589
898
"""
590
for name in (property_name,
591
property_name + u"_dbus_property"):
592
prop = getattr(self, name, None)
593
if (prop is None
594
or not self._is_dbus_property(prop)
595
or prop._dbus_name != property_name
596
or (interface_name and prop._dbus_interface
597
and interface_name != prop._dbus_interface)):
598
continue
599
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
600
907
# No such property
601
raise DBusPropertyNotFound(self.dbus_object_path + u":"
602
+ interface_name + u"."
908
raise DBusPropertyNotFound(self.dbus_object_path + ":"
909
+ interface_name + "."
603
910
+ property_name)
604
911
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
606
out_signature=u"v")
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
913
out_signature="v")
607
914
def Get(self, interface_name, property_name):
608
915
"""Standard D-Bus property Get() method, see D-Bus standard.
609
916
"""
610
917
prop = self._get_dbus_property(interface_name, property_name)
611
if prop._dbus_access == u"write":
918
if prop._dbus_access == "write":
612
919
raise DBusPropertyAccessException(property_name)
613
920
value = prop()
614
if not hasattr(value, u"variant_level"):
921
if not hasattr(value, "variant_level"):
615
922
return value
616
923
return type(value)(value, variant_level=value.variant_level+1)
617
924
618
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
925
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
619
926
def Set(self, interface_name, property_name, value):
620
927
"""Standard D-Bus property Set() method, see D-Bus standard.
621
928
"""
622
929
prop = self._get_dbus_property(interface_name, property_name)
623
if prop._dbus_access == u"read":
930
if prop._dbus_access == "read":
624
931
raise DBusPropertyAccessException(property_name)
625
if prop._dbus_get_args_options[u"byte_arrays"]:
932
if prop._dbus_get_args_options["byte_arrays"]:
626
933
# The byte_arrays option is not supported yet on
627
934
# signatures other than "ay".
628
if prop._dbus_signature != u"ay":
935
if prop._dbus_signature != "ay":
629
936
raise ValueError
630
value = dbus.ByteArray(''.join(unichr(byte)
631
for byte in value))
937
value = dbus.ByteArray(b''.join(chr(byte)
938
for byte in value))
632
939
prop(value)
633
940
634
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
635
out_signature=u"a{sv}")
941
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
942
out_signature="a{sv}")
636
943
def GetAll(self, interface_name):
637
944
"""Standard D-Bus property GetAll() method, see D-Bus
638
945
standard.
639
946
640
947
Note: Will not include properties with access="write".
641
948
"""
642
all = {}
643
for name, prop in self._get_all_dbus_properties():
949
properties = {}
950
for name, prop in self._get_all_dbus_things("property"):
644
951
if (interface_name
645
952
and interface_name != prop._dbus_interface):
646
953
# Interface non-empty but did not match
647
954
continue
648
955
# Ignore write-only properties
649
if prop._dbus_access == u"write":
956
if prop._dbus_access == "write":
650
957
continue
651
958
value = prop()
652
if not hasattr(value, u"variant_level"):
653
all[name] = value
959
if not hasattr(value, "variant_level"):
960
properties[name] = value
654
961
continue
655
all[name] = type(value)(value, variant_level=
656
value.variant_level+1)
657
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")
658
965
659
966
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
660
out_signature=u"s",
967
out_signature="s",
661
968
path_keyword='object_path',
662
969
connection_keyword='connection')
663
970
def Introspect(self, object_path, connection):
664
"""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.
665
974
"""
666
975
xmlstring = dbus.service.Object.Introspect(self, object_path,
667
976
connection)
668
977
try:
669
978
document = xml.dom.minidom.parseString(xmlstring)
670
979
def make_tag(document, name, prop):
671
e = document.createElement(u"property")
672
e.setAttribute(u"name", name)
673
e.setAttribute(u"type", prop._dbus_signature)
674
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)
675
984
return e
676
for if_tag in document.getElementsByTagName(u"interface"):
985
for if_tag in document.getElementsByTagName("interface"):
986
# Add property tags
677
987
for tag in (make_tag(document, name, prop)
678
988
for name, prop
679
in self._get_all_dbus_properties()
989
in self._get_all_dbus_things("property")
680
990
if prop._dbus_interface
681
== if_tag.getAttribute(u"name")):
991
== if_tag.getAttribute("name")):
682
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)
683
1024
# Add the names to the return values for the
684
1025
# "org.freedesktop.DBus.Properties" methods
685
if (if_tag.getAttribute(u"name")
686
== u"org.freedesktop.DBus.Properties"):
687
for cn in if_tag.getElementsByTagName(u"method"):
688
if cn.getAttribute(u"name") == u"Get":
689
for arg in cn.getElementsByTagName(u"arg"):
690
if (arg.getAttribute(u"direction")
691
== u"out"):
692
arg.setAttribute(u"name", u"value")
693
elif cn.getAttribute(u"name") == u"GetAll":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
696
== u"out"):
697
arg.setAttribute(u"name", u"props")
698
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")
699
1040
document.unlink()
700
1041
except (AttributeError, xml.dom.DOMException,
701
xml.parsers.expat.ExpatError), error:
702
logger.error(u"Failed to override Introspection method",
703
error)
1042
xml.parsers.expat.ExpatError) as error:
1043
logger.error("Failed to override Introspection method",
1044
exc_info=error)
704
1045
return xmlstring
705
1046
706
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"})
707
1227
class ClientDBus(Client, DBusObjectWithProperties):
708
1228
"""A Client class using D-Bus
709
1229
713
1233
"""
714
1234
715
1235
runtime_expansions = (Client.runtime_expansions
716
+ (u"dbus_object_path",))
1236
+ ("dbus_object_path",))
717
1237
718
1238
# dbus.service.Object doesn't use super(), so we can't either.
719
1239
720
1240
def __init__(self, bus = None, *args, **kwargs):
721
self._approvals_pending = 0
722
1241
self.bus = bus
723
1242
Client.__init__(self, *args, **kwargs)
724
1243
# Only now, when this client is initialized, can it show up on
725
1244
# the D-Bus
726
1245
client_object_name = unicode(self.name).translate(
727
{ord(u"."): ord(u"_"),
728
ord(u"-"): ord(u"_")})
1246
{ord("."): ord("_"),
1247
ord("-"): ord("_")})
729
1248
self.dbus_object_path = (dbus.ObjectPath
730
(u"/clients/" + client_object_name))
1249
("/clients/" + client_object_name))
731
1250
DBusObjectWithProperties.__init__(self, self.bus,
732
1251
self.dbus_object_path)
733
734
def _get_approvals_pending(self):
735
return self._approvals_pending
736
def _set_approvals_pending(self, value):
737
old_value = self._approvals_pending
738
self._approvals_pending = value
739
bval = bool(value)
740
if (hasattr(self, "dbus_object_path")
741
and bval is not bool(old_value)):
742
dbus_bool = dbus.Boolean(bval, variant_level=1)
743
self.PropertyChanged(dbus.String(u"ApprovalPending"),
744
dbus_bool)
745
746
approvals_pending = property(_get_approvals_pending,
747
_set_approvals_pending)
748
del _get_approvals_pending, _set_approvals_pending
749
750
@staticmethod
751
def _datetime_to_dbus(dt, variant_level=0):
752
"""Convert a UTC datetime.datetime() to a D-Bus type."""
753
return dbus.String(dt.isoformat(),
754
variant_level=variant_level)
755
756
def enable(self):
757
oldstate = getattr(self, u"enabled", False)
758
r = Client.enable(self)
759
if oldstate != self.enabled:
760
# Emit D-Bus signals
761
self.PropertyChanged(dbus.String(u"Enabled"),
762
dbus.Boolean(True, variant_level=1))
763
self.PropertyChanged(
764
dbus.String(u"LastEnabled"),
765
self._datetime_to_dbus(self.last_enabled,
766
variant_level=1))
767
return r
768
769
def disable(self, quiet = False):
770
oldstate = getattr(self, u"enabled", False)
771
r = Client.disable(self, quiet=quiet)
772
if not quiet and oldstate != self.enabled:
773
# Emit D-Bus signal
774
self.PropertyChanged(dbus.String(u"Enabled"),
775
dbus.Boolean(False, variant_level=1))
776
return r
1252
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
777
1320
778
1321
def __del__(self, *args, **kwargs):
779
1322
try:
780
1323
self.remove_from_connection()
781
1324
except LookupError:
782
1325
pass
783
if hasattr(DBusObjectWithProperties, u"__del__"):
1326
if hasattr(DBusObjectWithProperties, "__del__"):
784
1327
DBusObjectWithProperties.__del__(self, *args, **kwargs)
785
1328
Client.__del__(self, *args, **kwargs)
786
1329
788
1331
*args, **kwargs):
789
1332
self.checker_callback_tag = None
790
1333
self.checker = None
791
# Emit D-Bus signal
792
self.PropertyChanged(dbus.String(u"CheckerRunning"),
793
dbus.Boolean(False, variant_level=1))
794
1334
if os.WIFEXITED(condition):
795
1335
exitstatus = os.WEXITSTATUS(condition)
796
1336
# Emit D-Bus signal
806
1346
return Client.checker_callback(self, pid, condition, command,
807
1347
*args, **kwargs)
808
1348
809
def checked_ok(self, *args, **kwargs):
810
r = Client.checked_ok(self, *args, **kwargs)
811
# Emit D-Bus signal
812
self.PropertyChanged(
813
dbus.String(u"LastCheckedOK"),
814
(self._datetime_to_dbus(self.last_checked_ok,
815
variant_level=1)))
816
return r
817
818
1349
def start_checker(self, *args, **kwargs):
819
1350
old_checker = self.checker
820
1351
if self.checker is not None:
827
1358
and old_checker_pid != self.checker.pid):
828
1359
# Emit D-Bus signal
829
1360
self.CheckerStarted(self.current_checker_command)
830
self.PropertyChanged(
831
dbus.String(u"CheckerRunning"),
832
dbus.Boolean(True, variant_level=1))
833
1361
return r
834
1362
835
def stop_checker(self, *args, **kwargs):
836
old_checker = getattr(self, u"checker", None)
837
r = Client.stop_checker(self, *args, **kwargs)
838
if (old_checker is not None
839
and getattr(self, u"checker", None) is None):
840
self.PropertyChanged(dbus.String(u"CheckerRunning"),
841
dbus.Boolean(False, variant_level=1))
842
return r
843
844
1363
def _reset_approved(self):
845
self._approved = None
1364
self.approved = None
846
1365
return False
847
1366
848
1367
def approve(self, value=True):
849
self.send_changedstate()
850
self._approved = value
851
gobject.timeout_add(self._timedelta_to_milliseconds
1368
self.approved = value
1369
gobject.timeout_add(timedelta_to_milliseconds
852
1370
(self.approval_duration),
853
1371
self._reset_approved)
854
1372
self.send_changedstate()
855
1373
856
1374
## D-Bus methods, signals & properties
857
_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"}
858
1383
859
1384
## Signals
860
1385
861
1386
# CheckerCompleted - signal
862
@dbus.service.signal(_interface, signature=u"nxs")
1387
@dbus.service.signal(_interface, signature="nxs")
863
1388
def CheckerCompleted(self, exitcode, waitstatus, command):
864
1389
"D-Bus signal"
865
1390
pass
866
1391
867
1392
# CheckerStarted - signal
868
@dbus.service.signal(_interface, signature=u"s")
1393
@dbus.service.signal(_interface, signature="s")
869
1394
def CheckerStarted(self, command):
870
1395
"D-Bus signal"
871
1396
pass
872
1397
873
1398
# PropertyChanged - signal
874
@dbus.service.signal(_interface, signature=u"sv")
1399
@dbus.service.signal(_interface, signature="sv")
875
1400
def PropertyChanged(self, property, value):
876
1401
"D-Bus signal"
877
1402
pass
886
1411
pass
887
1412
888
1413
# Rejected - signal
889
@dbus.service.signal(_interface, signature=u"s")
1414
@dbus.service.signal(_interface, signature="s")
890
1415
def Rejected(self, reason):
891
1416
"D-Bus signal"
892
1417
pass
893
1418
894
1419
# NeedApproval - signal
895
@dbus.service.signal(_interface, signature=u"tb")
1420
@dbus.service.signal(_interface, signature="tb")
896
1421
def NeedApproval(self, timeout, default):
897
1422
"D-Bus signal"
898
pass
1423
return self.need_approval()
899
1424
900
1425
## Methods
901
1426
902
1427
# Approve - method
903
@dbus.service.method(_interface, in_signature=u"b")
1428
@dbus.service.method(_interface, in_signature="b")
904
1429
def Approve(self, value):
905
1430
self.approve(value)
906
1431
907
1432
# CheckedOK - method
908
1433
@dbus.service.method(_interface)
909
1434
def CheckedOK(self):
910
return self.checked_ok()
1435
self.checked_ok()
911
1436
912
1437
# Enable - method
913
1438
@dbus.service.method(_interface)
935
1460
## Properties
936
1461
937
1462
# ApprovalPending - property
938
@dbus_service_property(_interface, signature=u"b", access=u"read")
1463
@dbus_service_property(_interface, signature="b", access="read")
939
1464
def ApprovalPending_dbus_property(self):
940
1465
return dbus.Boolean(bool(self.approvals_pending))
941
1466
942
1467
# ApprovedByDefault - property
943
@dbus_service_property(_interface, signature=u"b",
944
access=u"readwrite")
1468
@dbus_service_property(_interface, signature="b",
1469
access="readwrite")
945
1470
def ApprovedByDefault_dbus_property(self, value=None):
946
1471
if value is None: # get
947
1472
return dbus.Boolean(self.approved_by_default)
948
1473
self.approved_by_default = bool(value)
949
# Emit D-Bus signal
950
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
951
dbus.Boolean(value, variant_level=1))
952
1474
953
1475
# ApprovalDelay - property
954
@dbus_service_property(_interface, signature=u"t",
955
access=u"readwrite")
1476
@dbus_service_property(_interface, signature="t",
1477
access="readwrite")
956
1478
def ApprovalDelay_dbus_property(self, value=None):
957
1479
if value is None: # get
958
1480
return dbus.UInt64(self.approval_delay_milliseconds())
959
1481
self.approval_delay = datetime.timedelta(0, 0, 0, value)
960
# Emit D-Bus signal
961
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
962
dbus.UInt64(value, variant_level=1))
963
1482
964
1483
# ApprovalDuration - property
965
@dbus_service_property(_interface, signature=u"t",
966
access=u"readwrite")
1484
@dbus_service_property(_interface, signature="t",
1485
access="readwrite")
967
1486
def ApprovalDuration_dbus_property(self, value=None):
968
1487
if value is None: # get
969
return dbus.UInt64(self._timedelta_to_milliseconds(
1488
return dbus.UInt64(timedelta_to_milliseconds(
970
1489
self.approval_duration))
971
1490
self.approval_duration = datetime.timedelta(0, 0, 0, value)
972
# Emit D-Bus signal
973
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
974
dbus.UInt64(value, variant_level=1))
975
1491
976
1492
# Name - property
977
@dbus_service_property(_interface, signature=u"s", access=u"read")
1493
@dbus_service_property(_interface, signature="s", access="read")
978
1494
def Name_dbus_property(self):
979
1495
return dbus.String(self.name)
980
1496
981
1497
# Fingerprint - property
982
@dbus_service_property(_interface, signature=u"s", access=u"read")
1498
@dbus_service_property(_interface, signature="s", access="read")
983
1499
def Fingerprint_dbus_property(self):
984
1500
return dbus.String(self.fingerprint)
985
1501
986
1502
# Host - property
987
@dbus_service_property(_interface, signature=u"s",
988
access=u"readwrite")
1503
@dbus_service_property(_interface, signature="s",
1504
access="readwrite")
989
1505
def Host_dbus_property(self, value=None):
990
1506
if value is None: # get
991
1507
return dbus.String(self.host)
992
self.host = value
993
# Emit D-Bus signal
994
self.PropertyChanged(dbus.String(u"Host"),
995
dbus.String(value, variant_level=1))
1508
self.host = unicode(value)
996
1509
997
1510
# Created - property
998
@dbus_service_property(_interface, signature=u"s", access=u"read")
1511
@dbus_service_property(_interface, signature="s", access="read")
999
1512
def Created_dbus_property(self):
1000
return dbus.String(self._datetime_to_dbus(self.created))
1513
return datetime_to_dbus(self.created)
1001
1514
1002
1515
# LastEnabled - property
1003
@dbus_service_property(_interface, signature=u"s", access=u"read")
1516
@dbus_service_property(_interface, signature="s", access="read")
1004
1517
def LastEnabled_dbus_property(self):
1005
if self.last_enabled is None:
1006
return dbus.String(u"")
1007
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1518
return datetime_to_dbus(self.last_enabled)
1008
1519
1009
1520
# Enabled - property
1010
@dbus_service_property(_interface, signature=u"b",
1011
access=u"readwrite")
1521
@dbus_service_property(_interface, signature="b",
1522
access="readwrite")
1012
1523
def Enabled_dbus_property(self, value=None):
1013
1524
if value is None: # get
1014
1525
return dbus.Boolean(self.enabled)
1018
1529
self.disable()
1019
1530
1020
1531
# LastCheckedOK - property
1021
@dbus_service_property(_interface, signature=u"s",
1022
access=u"readwrite")
1532
@dbus_service_property(_interface, signature="s",
1533
access="readwrite")
1023
1534
def LastCheckedOK_dbus_property(self, value=None):
1024
1535
if value is not None:
1025
1536
self.checked_ok()
1026
1537
return
1027
if self.last_checked_ok is None:
1028
return dbus.String(u"")
1029
return dbus.String(self._datetime_to_dbus(self
1030
.last_checked_ok))
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)
1031
1555
1032
1556
# Timeout - property
1033
@dbus_service_property(_interface, signature=u"t",
1034
access=u"readwrite")
1557
@dbus_service_property(_interface, signature="t",
1558
access="readwrite")
1035
1559
def Timeout_dbus_property(self, value=None):
1036
1560
if value is None: # get
1037
1561
return dbus.UInt64(self.timeout_milliseconds())
1562
old_timeout = self.timeout
1038
1563
self.timeout = datetime.timedelta(0, 0, 0, value)
1039
# Emit D-Bus signal
1040
self.PropertyChanged(dbus.String(u"Timeout"),
1041
dbus.UInt64(value, variant_level=1))
1042
if getattr(self, u"disable_initiator_tag", None) is None:
1043
return
1044
# Reschedule timeout
1045
gobject.source_remove(self.disable_initiator_tag)
1046
self.disable_initiator_tag = None
1047
time_to_die = (self.
1048
_timedelta_to_milliseconds((self
1049
.last_checked_ok
1050
+ self.timeout)
1051
- datetime.datetime
1052
.utcnow()))
1053
if time_to_die <= 0:
1054
# The timeout has passed
1055
self.disable()
1056
else:
1057
self.disable_initiator_tag = (gobject.timeout_add
1058
(time_to_die, self.disable))
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)
1059
1588
1060
1589
# Interval - property
1061
@dbus_service_property(_interface, signature=u"t",
1062
access=u"readwrite")
1590
@dbus_service_property(_interface, signature="t",
1591
access="readwrite")
1063
1592
def Interval_dbus_property(self, value=None):
1064
1593
if value is None: # get
1065
1594
return dbus.UInt64(self.interval_milliseconds())
1066
1595
self.interval = datetime.timedelta(0, 0, 0, value)
1067
# Emit D-Bus signal
1068
self.PropertyChanged(dbus.String(u"Interval"),
1069
dbus.UInt64(value, variant_level=1))
1070
if getattr(self, u"checker_initiator_tag", None) is None:
1596
if getattr(self, "checker_initiator_tag", None) is None:
1071
1597
return
1072
# Reschedule checker run
1073
gobject.source_remove(self.checker_initiator_tag)
1074
self.checker_initiator_tag = (gobject.timeout_add
1075
(value, self.start_checker))
1076
self.start_checker() # Start one now, too
1077
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
1078
1605
# Checker - property
1079
@dbus_service_property(_interface, signature=u"s",
1080
access=u"readwrite")
1606
@dbus_service_property(_interface, signature="s",
1607
access="readwrite")
1081
1608
def Checker_dbus_property(self, value=None):
1082
1609
if value is None: # get
1083
1610
return dbus.String(self.checker_command)
1084
self.checker_command = value
1085
# Emit D-Bus signal
1086
self.PropertyChanged(dbus.String(u"Checker"),
1087
dbus.String(self.checker_command,
1088
variant_level=1))
1611
self.checker_command = unicode(value)
1089
1612
1090
1613
# CheckerRunning - property
1091
@dbus_service_property(_interface, signature=u"b",
1092
access=u"readwrite")
1614
@dbus_service_property(_interface, signature="b",
1615
access="readwrite")
1093
1616
def CheckerRunning_dbus_property(self, value=None):
1094
1617
if value is None: # get
1095
1618
return dbus.Boolean(self.checker is not None)
1099
1622
self.stop_checker()
1100
1623
1101
1624
# ObjectPath - property
1102
@dbus_service_property(_interface, signature=u"o", access=u"read")
1625
@dbus_service_property(_interface, signature="o", access="read")
1103
1626
def ObjectPath_dbus_property(self):
1104
1627
return self.dbus_object_path # is already a dbus.ObjectPath
1105
1628
1106
1629
# Secret = property
1107
@dbus_service_property(_interface, signature=u"ay",
1108
access=u"write", byte_arrays=True)
1630
@dbus_service_property(_interface, signature="ay",
1631
access="write", byte_arrays=True)
1109
1632
def Secret_dbus_property(self, value):
1110
1633
self.secret = str(value)
1111
1634
1118
1641
self._pipe.send(('init', fpr, address))
1119
1642
if not self._pipe.recv():
1120
1643
raise KeyError()
1121
1644
1122
1645
def __getattribute__(self, name):
1123
if(name == '_pipe'):
1646
if name == '_pipe':
1124
1647
return super(ProxyClient, self).__getattribute__(name)
1125
1648
self._pipe.send(('getattr', name))
1126
1649
data = self._pipe.recv()
1131
1654
self._pipe.send(('funcall', name, args, kwargs))
1132
1655
return self._pipe.recv()[1]
1133
1656
return func
1134
1657
1135
1658
def __setattr__(self, name, value):
1136
if(name == '_pipe'):
1659
if name == '_pipe':
1137
1660
return super(ProxyClient, self).__setattr__(name, value)
1138
1661
self._pipe.send(('setattr', name, value))
1139
1662
1146
1669
1147
1670
def handle(self):
1148
1671
with contextlib.closing(self.server.child_pipe) as child_pipe:
1149
logger.info(u"TCP connection from: %s",
1672
logger.info("TCP connection from: %s",
1150
1673
unicode(self.client_address))
1151
logger.debug(u"Pipe FD: %d",
1674
logger.debug("Pipe FD: %d",
1152
1675
self.server.child_pipe.fileno())
1153
1676
1154
1677
session = (gnutls.connection
1155
1678
.ClientSession(self.request,
1156
1679
gnutls.connection
1157
1680
.X509Credentials()))
1158
1681
1159
1682
# Note: gnutls.connection.X509Credentials is really a
1160
1683
# generic GnuTLS certificate credentials object so long as
1161
1684
# no X.509 keys are added to it. Therefore, we can use it
1162
1685
# here despite using OpenPGP certificates.
1163
1164
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1165
# u"+AES-256-CBC", u"+SHA1",
1166
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1167
# u"+DHE-DSS"))
1686
1687
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1688
# "+AES-256-CBC", "+SHA1",
1689
# "+COMP-NULL", "+CTYPE-OPENPGP",
1690
# "+DHE-DSS"))
1168
1691
# Use a fallback default, since this MUST be set.
1169
1692
priority = self.server.gnutls_priority
1170
1693
if priority is None:
1171
priority = u"NORMAL"
1694
priority = "NORMAL"
1172
1695
(gnutls.library.functions
1173
1696
.gnutls_priority_set_direct(session._c_object,
1174
1697
priority, None))
1175
1698
1176
1699
# Start communication using the Mandos protocol
1177
1700
# Get protocol number
1178
1701
line = self.request.makefile().readline()
1179
logger.debug(u"Protocol version: %r", line)
1702
logger.debug("Protocol version: %r", line)
1180
1703
try:
1181
1704
if int(line.strip().split()[0]) > 1:
1182
1705
raise RuntimeError
1183
except (ValueError, IndexError, RuntimeError), error:
1184
logger.error(u"Unknown protocol version: %s", error)
1706
except (ValueError, IndexError, RuntimeError) as error:
1707
logger.error("Unknown protocol version: %s", error)
1185
1708
return
1186
1709
1187
1710
# Start GnuTLS connection
1188
1711
try:
1189
1712
session.handshake()
1190
except gnutls.errors.GNUTLSError, error:
1191
logger.warning(u"Handshake failed: %s", error)
1713
except gnutls.errors.GNUTLSError as error:
1714
logger.warning("Handshake failed: %s", error)
1192
1715
# Do not run session.bye() here: the session is not
1193
1716
# established. Just abandon the request.
1194
1717
return
1195
logger.debug(u"Handshake succeeded")
1196
1718
logger.debug("Handshake succeeded")
1719
1197
1720
approval_required = False
1198
1721
try:
1199
1722
try:
1200
1723
fpr = self.fingerprint(self.peer_certificate
1201
1724
(session))
1202
except (TypeError, gnutls.errors.GNUTLSError), error:
1203
logger.warning(u"Bad certificate: %s", error)
1725
except (TypeError,
1726
gnutls.errors.GNUTLSError) as error:
1727
logger.warning("Bad certificate: %s", error)
1204
1728
return
1205
logger.debug(u"Fingerprint: %s", fpr)
1206
1729
logger.debug("Fingerprint: %s", fpr)
1730
1207
1731
try:
1208
1732
client = ProxyClient(child_pipe, fpr,
1209
1733
self.client_address)
1217
1741
1218
1742
while True:
1219
1743
if not client.enabled:
1220
logger.warning(u"Client %s is disabled",
1744
logger.info("Client %s is disabled",
1221
1745
client.name)
1222
1746
if self.server.use_dbus:
1223
1747
# Emit D-Bus signal
1224
client.Rejected("Disabled")
1748
client.Rejected("Disabled")
1225
1749
return
1226
1750
1227
if client._approved or not client.approval_delay:
1751
if client.approved or not client.approval_delay:
1228
1752
#We are approved or approval is disabled
1229
1753
break
1230
elif client._approved is None:
1231
logger.info(u"Client %s needs approval",
1754
elif client.approved is None:
1755
logger.info("Client %s needs approval",
1232
1756
client.name)
1233
1757
if self.server.use_dbus:
1234
1758
# Emit D-Bus signal
1236
1760
client.approval_delay_milliseconds(),
1237
1761
client.approved_by_default)
1238
1762
else:
1239
logger.warning(u"Client %s was not approved",
1763
logger.warning("Client %s was not approved",
1240
1764
client.name)
1241
1765
if self.server.use_dbus:
1242
1766
# Emit D-Bus signal
1244
1768
return
1245
1769
1246
1770
#wait until timeout or approved
1247
#x = float(client._timedelta_to_milliseconds(delay))
1248
1771
time = datetime.datetime.now()
1249
1772
client.changedstate.acquire()
1250
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1773
client.changedstate.wait(
1774
float(timedelta_to_milliseconds(delay)
1775
/ 1000))
1251
1776
client.changedstate.release()
1252
1777
time2 = datetime.datetime.now()
1253
1778
if (time2 - time) >= delay:
1268
1793
while sent_size < len(client.secret):
1269
1794
try:
1270
1795
sent = session.send(client.secret[sent_size:])
1271
except (gnutls.errors.GNUTLSError), error:
1272
logger.warning("gnutls send failed")
1796
except gnutls.errors.GNUTLSError as error:
1797
logger.warning("gnutls send failed",
1798
exc_info=error)
1273
1799
return
1274
logger.debug(u"Sent: %d, remaining: %d",
1800
logger.debug("Sent: %d, remaining: %d",
1275
1801
sent, len(client.secret)
1276
1802
- (sent_size + sent))
1277
1803
sent_size += sent
1278
1279
logger.info(u"Sending secret to %s", client.name)
1280
# bump the timeout as if seen
1281
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)
1282
1808
if self.server.use_dbus:
1283
1809
# Emit D-Bus signal
1284
1810
client.GotSecret()
1288
1814
client.approvals_pending -= 1
1289
1815
try:
1290
1816
session.bye()
1291
except (gnutls.errors.GNUTLSError), error:
1292
logger.warning("GnuTLS bye failed")
1817
except gnutls.errors.GNUTLSError as error:
1818
logger.warning("GnuTLS bye failed",
1819
exc_info=error)
1293
1820
1294
1821
@staticmethod
1295
1822
def peer_certificate(session):
1305
1832
.gnutls_certificate_get_peers
1306
1833
(session._c_object, ctypes.byref(list_size)))
1307
1834
if not bool(cert_list) and list_size.value != 0:
1308
raise gnutls.errors.GNUTLSError(u"error getting peer"
1309
u" certificate")
1835
raise gnutls.errors.GNUTLSError("error getting peer"
1836
" certificate")
1310
1837
if list_size.value == 0:
1311
1838
return None
1312
1839
cert = cert_list[0]
1338
1865
if crtverify.value != 0:
1339
1866
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1340
1867
raise (gnutls.errors.CertificateSecurityError
1341
(u"Verify failed"))
1868
("Verify failed"))
1342
1869
# New buffer for the fingerprint
1343
1870
buf = ctypes.create_string_buffer(20)
1344
1871
buf_len = ctypes.c_size_t()
1351
1878
# Convert the buffer to a Python bytestring
1352
1879
fpr = ctypes.string_at(buf, buf_len.value)
1353
1880
# Convert the bytestring to hexadecimal notation
1354
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1881
hex_fpr = binascii.hexlify(fpr).upper()
1355
1882
return hex_fpr
1356
1883
1357
1884
1360
1887
def sub_process_main(self, request, address):
1361
1888
try:
1362
1889
self.finish_request(request, address)
1363
except:
1890
except Exception:
1364
1891
self.handle_error(request, address)
1365
1892
self.close_request(request)
1366
1893
1367
1894
def process_request(self, request, address):
1368
1895
"""Start a new process to process the request."""
1369
multiprocessing.Process(target = self.sub_process_main,
1370
args = (request, address)).start()
1896
proc = multiprocessing.Process(target = self.sub_process_main,
1897
args = (request, address))
1898
proc.start()
1899
return proc
1900
1371
1901
1372
1902
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1373
1903
""" adds a pipe to the MixIn """
1377
1907
This function creates a new pipe in self.pipe
1378
1908
"""
1379
1909
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1380
1381
super(MultiprocessingMixInWithPipe,
1382
self).process_request(request, client_address)
1910
1911
proc = MultiprocessingMixIn.process_request(self, request,
1912
client_address)
1383
1913
self.child_pipe.close()
1384
self.add_pipe(parent_pipe)
1385
1386
def add_pipe(self, parent_pipe):
1914
self.add_pipe(parent_pipe, proc)
1915
1916
def add_pipe(self, parent_pipe, proc):
1387
1917
"""Dummy function; override as necessary"""
1388
pass
1918
raise NotImplementedError
1919
1389
1920
1390
1921
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1391
1922
socketserver.TCPServer, object):
1397
1928
use_ipv6: Boolean; to use IPv6 or not
1398
1929
"""
1399
1930
def __init__(self, server_address, RequestHandlerClass,
1400
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
"""
1401
1935
self.interface = interface
1402
1936
if use_ipv6:
1403
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.
1404
1964
socketserver.TCPServer.__init__(self, server_address,
1405
1965
RequestHandlerClass)
1966
1406
1967
def server_bind(self):
1407
1968
"""This overrides the normal server_bind() function
1408
1969
to bind to an interface if one was specified, and also NOT to
1409
1970
bind to an address or port if they were not specified."""
1410
1971
if self.interface is not None:
1411
1972
if SO_BINDTODEVICE is None:
1412
logger.error(u"SO_BINDTODEVICE does not exist;"
1413
u" cannot bind to interface %s",
1973
logger.error("SO_BINDTODEVICE does not exist;"
1974
" cannot bind to interface %s",
1414
1975
self.interface)
1415
1976
else:
1416
1977
try:
1417
1978
self.socket.setsockopt(socket.SOL_SOCKET,
1418
1979
SO_BINDTODEVICE,
1419
str(self.interface
1420
+ u'\0'))
1421
except socket.error, error:
1422
if error[0] == errno.EPERM:
1423
logger.error(u"No permission to"
1424
u" bind to interface %s",
1425
self.interface)
1426
elif error[0] == errno.ENOPROTOOPT:
1427
logger.error(u"SO_BINDTODEVICE not available;"
1428
u" cannot bind to interface %s",
1429
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)
1430
1992
else:
1431
1993
raise
1432
1994
# Only bind(2) the socket if we really need to.
1433
1995
if self.server_address[0] or self.server_address[1]:
1434
1996
if not self.server_address[0]:
1435
1997
if self.address_family == socket.AF_INET6:
1436
any_address = u"::" # in6addr_any
1998
any_address = "::" # in6addr_any
1437
1999
else:
1438
any_address = socket.INADDR_ANY
2000
any_address = "0.0.0.0" # INADDR_ANY
1439
2001
self.server_address = (any_address,
1440
2002
self.server_address[1])
1441
2003
elif not self.server_address[1]:
1462
2024
"""
1463
2025
def __init__(self, server_address, RequestHandlerClass,
1464
2026
interface=None, use_ipv6=True, clients=None,
1465
gnutls_priority=None, use_dbus=True):
2027
gnutls_priority=None, use_dbus=True, socketfd=None):
1466
2028
self.enabled = False
1467
2029
self.clients = clients
1468
2030
if self.clients is None:
1469
self.clients = set()
2031
self.clients = {}
1470
2032
self.use_dbus = use_dbus
1471
2033
self.gnutls_priority = gnutls_priority
1472
2034
IPv6_TCPServer.__init__(self, server_address,
1473
2035
RequestHandlerClass,
1474
2036
interface = interface,
1475
use_ipv6 = use_ipv6)
2037
use_ipv6 = use_ipv6,
2038
socketfd = socketfd)
1476
2039
def server_activate(self):
1477
2040
if self.enabled:
1478
2041
return socketserver.TCPServer.server_activate(self)
2042
1479
2043
def enable(self):
1480
2044
self.enabled = True
1481
def add_pipe(self, parent_pipe):
2045
2046
def add_pipe(self, parent_pipe, proc):
1482
2047
# Call "handle_ipc" for both data and EOF events
1483
2048
gobject.io_add_watch(parent_pipe.fileno(),
1484
2049
gobject.IO_IN | gobject.IO_HUP,
1485
2050
functools.partial(self.handle_ipc,
1486
parent_pipe = parent_pipe))
1487
2051
parent_pipe =
2052
parent_pipe,
2053
proc = proc))
2054
1488
2055
def handle_ipc(self, source, condition, parent_pipe=None,
1489
client_object=None):
1490
condition_names = {
1491
gobject.IO_IN: u"IN", # There is data to read.
1492
gobject.IO_OUT: u"OUT", # Data can be written (without
1493
# blocking).
1494
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1495
gobject.IO_ERR: u"ERR", # Error condition.
1496
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1497
# broken, usually for pipes and
1498
# sockets).
1499
}
1500
conditions_string = ' | '.join(name
1501
for cond, name in
1502
condition_names.iteritems()
1503
if cond & condition)
1504
# error or the other end of multiprocessing.Pipe has closed
1505
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
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()
1506
2061
return False
1507
2062
1508
2063
# Read a request from the child
1513
2068
fpr = request[1]
1514
2069
address = request[2]
1515
2070
1516
for c in self.clients:
2071
for c in self.clients.itervalues():
1517
2072
if c.fingerprint == fpr:
1518
2073
client = c
1519
2074
break
1520
2075
else:
1521
logger.warning(u"Client not found for fingerprint: %s, ad"
1522
u"dress: %s", fpr, address)
2076
logger.info("Client not found for fingerprint: %s, ad"
2077
"dress: %s", fpr, address)
1523
2078
if self.use_dbus:
1524
2079
# Emit D-Bus signal
1525
mandos_dbus_service.ClientNotFound(fpr, address[0])
2080
mandos_dbus_service.ClientNotFound(fpr,
2081
address[0])
1526
2082
parent_pipe.send(False)
1527
2083
return False
1528
2084
1529
2085
gobject.io_add_watch(parent_pipe.fileno(),
1530
2086
gobject.IO_IN | gobject.IO_HUP,
1531
2087
functools.partial(self.handle_ipc,
1532
parent_pipe = parent_pipe,
1533
client_object = client))
2088
parent_pipe =
2089
parent_pipe,
2090
proc = proc,
2091
client_object =
2092
client))
1534
2093
parent_pipe.send(True)
1535
# 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
1536
2096
return False
1537
2097
if command == 'funcall':
1538
2098
funcname = request[1]
1539
2099
args = request[2]
1540
2100
kwargs = request[3]
1541
2101
1542
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1543
2102
parent_pipe.send(('data', getattr(client_object,
2103
funcname)(*args,
2104
**kwargs)))
2105
1544
2106
if command == 'getattr':
1545
2107
attrname = request[1]
1546
2108
if callable(client_object.__getattribute__(attrname)):
1547
2109
parent_pipe.send(('function',))
1548
2110
else:
1549
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2111
parent_pipe.send(('data', client_object
2112
.__getattribute__(attrname)))
1550
2113
1551
2114
if command == 'setattr':
1552
2115
attrname = request[1]
1553
2116
value = request[2]
1554
2117
setattr(client_object, attrname, value)
1555
2118
1556
2119
return True
1557
2120
1558
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
1559
2221
def string_to_delta(interval):
1560
2222
"""Parse a string and return a datetime.timedelta
1561
2223
1562
>>> string_to_delta(u'7d')
2224
>>> string_to_delta('7d')
1563
2225
datetime.timedelta(7)
1564
>>> string_to_delta(u'60s')
2226
>>> string_to_delta('60s')
1565
2227
datetime.timedelta(0, 60)
1566
>>> string_to_delta(u'60m')
2228
>>> string_to_delta('60m')
1567
2229
datetime.timedelta(0, 3600)
1568
>>> string_to_delta(u'24h')
2230
>>> string_to_delta('24h')
1569
2231
datetime.timedelta(1)
1570
>>> string_to_delta(u'1w')
2232
>>> string_to_delta('1w')
1571
2233
datetime.timedelta(7)
1572
>>> string_to_delta(u'5m 30s')
2234
>>> string_to_delta('5m 30s')
1573
2235
datetime.timedelta(0, 330)
1574
2236
"""
2237
2238
try:
2239
return rfc3339_duration_to_delta(interval)
2240
except ValueError:
2241
pass
2242
1575
2243
timevalue = datetime.timedelta(0)
1576
2244
for s in interval.split():
1577
2245
try:
1578
2246
suffix = unicode(s[-1])
1579
2247
value = int(s[:-1])
1580
if suffix == u"d":
2248
if suffix == "d":
1581
2249
delta = datetime.timedelta(value)
1582
elif suffix == u"s":
2250
elif suffix == "s":
1583
2251
delta = datetime.timedelta(0, value)
1584
elif suffix == u"m":
2252
elif suffix == "m":
1585
2253
delta = datetime.timedelta(0, 0, 0, 0, value)
1586
elif suffix == u"h":
2254
elif suffix == "h":
1587
2255
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1588
elif suffix == u"w":
2256
elif suffix == "w":
1589
2257
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1590
2258
else:
1591
raise ValueError(u"Unknown suffix %r" % suffix)
1592
except (ValueError, IndexError), e:
1593
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))
1594
2263
timevalue += delta
1595
2264
return timevalue
1596
2265
1597
2266
1598
def if_nametoindex(interface):
1599
"""Call the C function if_nametoindex(), or equivalent
1600
1601
Note: This function cannot accept a unicode string."""
1602
global if_nametoindex
1603
try:
1604
if_nametoindex = (ctypes.cdll.LoadLibrary
1605
(ctypes.util.find_library(u"c"))
1606
.if_nametoindex)
1607
except (OSError, AttributeError):
1608
logger.warning(u"Doing if_nametoindex the hard way")
1609
def if_nametoindex(interface):
1610
"Get an interface index the hard way, i.e. using fcntl()"
1611
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1612
with contextlib.closing(socket.socket()) as s:
1613
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1614
struct.pack(str(u"16s16x"),
1615
interface))
1616
interface_index = struct.unpack(str(u"I"),
1617
ifreq[16:20])[0]
1618
return interface_index
1619
return if_nametoindex(interface)
1620
1621
1622
2267
def daemon(nochdir = False, noclose = False):
1623
2268
"""See daemon(3). Standard BSD Unix function.
1624
2269
1627
2272
sys.exit()
1628
2273
os.setsid()
1629
2274
if not nochdir:
1630
os.chdir(u"/")
2275
os.chdir("/")
1631
2276
if os.fork():
1632
2277
sys.exit()
1633
2278
if not noclose:
1634
2279
# Close all standard open file descriptors
1635
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2280
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1636
2281
if not stat.S_ISCHR(os.fstat(null).st_mode):
1637
2282
raise OSError(errno.ENODEV,
1638
u"%s not a character device"
1639
% os.path.devnull)
2283
"{0} not a character device"
2284
.format(os.devnull))
1640
2285
os.dup2(null, sys.stdin.fileno())
1641
2286
os.dup2(null, sys.stdout.fileno())
1642
2287
os.dup2(null, sys.stderr.fileno())
1649
2294
##################################################################
1650
2295
# Parsing of options, both command line and config file
1651
2296
1652
parser = optparse.OptionParser(version = "%%prog %s" % version)
1653
parser.add_option("-i", u"--interface", type=u"string",
1654
metavar="IF", help=u"Bind to interface IF")
1655
parser.add_option("-a", u"--address", type=u"string",
1656
help=u"Address to listen for requests on")
1657
parser.add_option("-p", u"--port", type=u"int",
1658
help=u"Port number to receive requests on")
1659
parser.add_option("--check", action=u"store_true",
1660
help=u"Run self-test")
1661
parser.add_option("--debug", action=u"store_true",
1662
help=u"Debug mode; run in foreground and log to"
1663
u" terminal")
1664
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1665
help=u"Debug level for stdout output")
1666
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1667
u" priority string (see GnuTLS documentation)")
1668
parser.add_option("--servicename", type=u"string",
1669
metavar=u"NAME", help=u"Zeroconf service name")
1670
parser.add_option("--configdir", type=u"string",
1671
default=u"/etc/mandos", metavar=u"DIR",
1672
help=u"Directory to search for configuration"
1673
u" files")
1674
parser.add_option("--no-dbus", action=u"store_false",
1675
dest=u"use_dbus", help=u"Do not provide D-Bus"
1676
u" system bus interface")
1677
parser.add_option("--no-ipv6", action=u"store_false",
1678
dest=u"use_ipv6", help=u"Do not use IPv6")
1679
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()
1680
2340
1681
2341
if options.check:
1682
2342
import doctest
1684
2344
sys.exit()
1685
2345
1686
2346
# Default values for config file for server-global settings
1687
server_defaults = { u"interface": u"",
1688
u"address": u"",
1689
u"port": u"",
1690
u"debug": u"False",
1691
u"priority":
1692
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1693
u"servicename": u"Mandos",
1694
u"use_dbus": u"True",
1695
u"use_ipv6": u"True",
1696
u"debuglevel": u"",
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",
1697
2361
}
1698
2362
1699
2363
# Parse config file for server-global settings
1700
2364
server_config = configparser.SafeConfigParser(server_defaults)
1701
2365
del server_defaults
1702
2366
server_config.read(os.path.join(options.configdir,
1703
u"mandos.conf"))
2367
"mandos.conf"))
1704
2368
# Convert the SafeConfigParser object to a dict
1705
2369
server_settings = server_config.defaults()
1706
2370
# Use the appropriate methods on the non-string config options
1707
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1708
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",
1709
2373
option)
1710
2374
if server_settings["port"]:
1711
server_settings["port"] = server_config.getint(u"DEFAULT",
1712
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"])
1713
2386
del server_config
1714
2387
1715
2388
# Override the settings from the config file with command line
1716
2389
# options, if set.
1717
for option in (u"interface", u"address", u"port", u"debug",
1718
u"priority", u"servicename", u"configdir",
1719
u"use_dbus", u"use_ipv6", u"debuglevel"):
2390
for option in ("interface", "address", "port", "debug",
2391
"priority", "servicename", "configdir",
2392
"use_dbus", "use_ipv6", "debuglevel", "restore",
2393
"statedir", "socket", "foreground"):
1720
2394
value = getattr(options, option)
1721
2395
if value is not None:
1722
2396
server_settings[option] = value
1725
2399
for option in server_settings.keys():
1726
2400
if type(server_settings[option]) is str:
1727
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
1728
2409
# Now we have our good server settings in "server_settings"
1729
2410
1730
2411
##################################################################
1731
2412
1732
2413
# For convenience
1733
debug = server_settings[u"debug"]
1734
debuglevel = server_settings[u"debuglevel"]
1735
use_dbus = server_settings[u"use_dbus"]
1736
use_ipv6 = server_settings[u"use_ipv6"]
1737
1738
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":
1739
2432
syslogger.setFormatter(logging.Formatter
1740
(u'Mandos (%s) [%%(process)d]:'
1741
u' %%(levelname)s: %%(message)s'
1742
% server_settings[u"servicename"]))
2433
('Mandos ({0}) [%(process)d]:'
2434
' %(levelname)s: %(message)s'
2435
.format(server_settings
2436
["servicename"])))
1743
2437
1744
2438
# Parse config file with clients
1745
client_defaults = { u"timeout": u"1h",
1746
u"interval": u"5m",
1747
u"checker": u"fping -q -- %%(host)s",
1748
u"host": u"",
1749
u"approval_delay": u"0s",
1750
u"approval_duration": u"1s",
1751
}
1752
client_config = configparser.SafeConfigParser(client_defaults)
1753
client_config.read(os.path.join(server_settings[u"configdir"],
1754
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"))
1755
2443
1756
2444
global mandos_dbus_service
1757
2445
mandos_dbus_service = None
1758
2446
1759
tcp_server = MandosServer((server_settings[u"address"],
1760
server_settings[u"port"]),
2447
tcp_server = MandosServer((server_settings["address"],
2448
server_settings["port"]),
1761
2449
ClientHandler,
1762
interface=(server_settings[u"interface"]
2450
interface=(server_settings["interface"]
1763
2451
or None),
1764
2452
use_ipv6=use_ipv6,
1765
2453
gnutls_priority=
1766
server_settings[u"priority"],
1767
use_dbus=use_dbus)
1768
if not debug:
1769
pidfilename = u"/var/run/mandos.pid"
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
1770
2463
try:
1771
pidfile = open(pidfilename, u"w")
1772
except IOError:
1773
logger.error(u"Could not open file %r", pidfilename)
2464
pidfile = open(pidfilename, "w")
2465
except IOError as e:
2466
logger.error("Could not open file %r", pidfilename,
2467
exc_info=e)
1774
2468
1775
try:
1776
uid = pwd.getpwnam(u"_mandos").pw_uid
1777
gid = pwd.getpwnam(u"_mandos").pw_gid
1778
except KeyError:
2469
for name in ("_mandos", "mandos", "nobody"):
1779
2470
try:
1780
uid = pwd.getpwnam(u"mandos").pw_uid
1781
gid = pwd.getpwnam(u"mandos").pw_gid
2471
uid = pwd.getpwnam(name).pw_uid
2472
gid = pwd.getpwnam(name).pw_gid
2473
break
1782
2474
except KeyError:
1783
try:
1784
uid = pwd.getpwnam(u"nobody").pw_uid
1785
gid = pwd.getpwnam(u"nobody").pw_gid
1786
except KeyError:
1787
uid = 65534
1788
gid = 65534
2475
continue
2476
else:
2477
uid = 65534
2478
gid = 65534
1789
2479
try:
1790
2480
os.setgid(gid)
1791
2481
os.setuid(uid)
1792
except OSError, error:
1793
if error[0] != errno.EPERM:
2482
except OSError as error:
2483
if error.errno != errno.EPERM:
1794
2484
raise error
1795
2485
1796
if not debug and not debuglevel:
1797
syslogger.setLevel(logging.WARNING)
1798
console.setLevel(logging.WARNING)
1799
if debuglevel:
1800
level = getattr(logging, debuglevel.upper())
1801
syslogger.setLevel(level)
1802
console.setLevel(level)
1803
1804
2486
if debug:
1805
2487
# Enable all possible GnuTLS debugging
1806
2488
1810
2492
1811
2493
@gnutls.library.types.gnutls_log_func
1812
2494
def debug_gnutls(level, string):
1813
logger.debug(u"GnuTLS: %s", string[:-1])
2495
logger.debug("GnuTLS: %s", string[:-1])
1814
2496
1815
2497
(gnutls.library.functions
1816
2498
.gnutls_global_set_log_function(debug_gnutls))
1817
2499
1818
2500
# Redirect stdin so all checkers get /dev/null
1819
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2501
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1820
2502
os.dup2(null, sys.stdin.fileno())
1821
2503
if null > 2:
1822
2504
os.close(null)
1823
else:
1824
# No console logging
1825
logger.removeHandler(console)
1826
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()
1827
2514
1828
2515
global main_loop
1829
2516
# From the Avahi example code
1830
DBusGMainLoop(set_as_default=True )
2517
DBusGMainLoop(set_as_default=True)
1831
2518
main_loop = gobject.MainLoop()
1832
2519
bus = dbus.SystemBus()
1833
2520
# End of Avahi example code
1834
2521
if use_dbus:
1835
2522
try:
1836
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2523
bus_name = dbus.service.BusName("se.recompile.Mandos",
1837
2524
bus, do_not_queue=True)
1838
except dbus.exceptions.NameExistsException, e:
1839
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)
1840
2530
use_dbus = False
1841
server_settings[u"use_dbus"] = False
2531
server_settings["use_dbus"] = False
1842
2532
tcp_server.use_dbus = False
1843
2533
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1844
service = AvahiService(name = server_settings[u"servicename"],
1845
servicetype = u"_mandos._tcp",
1846
protocol = protocol, bus = bus)
2534
service = AvahiServiceToSyslog(name =
2535
server_settings["servicename"],
2536
servicetype = "_mandos._tcp",
2537
protocol = protocol, bus = bus)
1847
2538
if server_settings["interface"]:
1848
2539
service.interface = (if_nametoindex
1849
(str(server_settings[u"interface"])))
1850
1851
if not debug:
1852
# Close all input and output, do double fork, etc.
1853
daemon()
1854
2540
(str(server_settings["interface"])))
2541
1855
2542
global multiprocessing_manager
1856
2543
multiprocessing_manager = multiprocessing.Manager()
1857
2544
1858
2545
client_class = Client
1859
2546
if use_dbus:
1860
2547
client_class = functools.partial(ClientDBus, bus = bus)
1861
def client_config_items(config, section):
1862
special_settings = {
1863
"approved_by_default":
1864
lambda: config.getboolean(section,
1865
"approved_by_default"),
1866
}
1867
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))
1868
2630
try:
1869
yield (name, special_settings[name]())
1870
except KeyError:
1871
yield (name, value)
1872
1873
tcp_server.clients.update(set(
1874
client_class(name = section,
1875
config= dict(client_config_items(
1876
client_config, section)))
1877
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
1878
2656
if not tcp_server.clients:
1879
logger.warning(u"No clients defined")
1880
1881
if not debug:
1882
try:
1883
with pidfile:
1884
pid = os.getpid()
1885
pidfile.write(str(pid) + "\n")
1886
del pidfile
1887
except IOError:
1888
logger.error(u"Could not write to file %r with PID %d",
1889
pidfilename, pid)
1890
except NameError:
1891
# "pidfile" was never created
1892
pass
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)
2668
del pidfile
1893
2669
del pidfilename
1894
1895
signal.signal(signal.SIGINT, signal.SIG_IGN)
1896
2670
1897
2671
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1898
2672
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1899
2673
1900
2674
if use_dbus:
1901
class MandosDBusService(dbus.service.Object):
2675
@alternate_dbus_interfaces({"se.recompile.Mandos":
2676
"se.bsnet.fukt.Mandos"})
2677
class MandosDBusService(DBusObjectWithProperties):
1902
2678
"""A D-Bus proxy object"""
1903
2679
def __init__(self):
1904
dbus.service.Object.__init__(self, bus, u"/")
1905
_interface = u"se.bsnet.fukt.Mandos"
1906
1907
@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")
1908
2690
def ClientAdded(self, objpath):
1909
2691
"D-Bus signal"
1910
2692
pass
1911
2693
1912
@dbus.service.signal(_interface, signature=u"ss")
2694
@dbus.service.signal(_interface, signature="ss")
1913
2695
def ClientNotFound(self, fingerprint, address):
1914
2696
"D-Bus signal"
1915
2697
pass
1916
2698
1917
@dbus.service.signal(_interface, signature=u"os")
2699
@dbus.service.signal(_interface, signature="os")
1918
2700
def ClientRemoved(self, objpath, name):
1919
2701
"D-Bus signal"
1920
2702
pass
1921
2703
1922
@dbus.service.method(_interface, out_signature=u"ao")
2704
@dbus.service.method(_interface, out_signature="ao")
1923
2705
def GetAllClients(self):
1924
2706
"D-Bus method"
1925
2707
return dbus.Array(c.dbus_object_path
1926
for c in tcp_server.clients)
2708
for c in
2709
tcp_server.clients.itervalues())
1927
2710
1928
2711
@dbus.service.method(_interface,
1929
out_signature=u"a{oa{sv}}")
2712
out_signature="a{oa{sv}}")
1930
2713
def GetAllClientsWithProperties(self):
1931
2714
"D-Bus method"
1932
2715
return dbus.Dictionary(
1933
((c.dbus_object_path, c.GetAll(u""))
1934
for c in tcp_server.clients),
1935
signature=u"oa{sv}")
2716
((c.dbus_object_path, c.GetAll(""))
2717
for c in tcp_server.clients.itervalues()),
2718
signature="oa{sv}")
1936
2719
1937
@dbus.service.method(_interface, in_signature=u"o")
2720
@dbus.service.method(_interface, in_signature="o")
1938
2721
def RemoveClient(self, object_path):
1939
2722
"D-Bus method"
1940
for c in tcp_server.clients:
2723
for c in tcp_server.clients.itervalues():
1941
2724
if c.dbus_object_path == object_path:
1942
tcp_server.clients.remove(c)
2725
del tcp_server.clients[c.name]
1943
2726
c.remove_from_connection()
1944
2727
# Don't signal anything except ClientRemoved
1945
2728
c.disable(quiet=True)
1956
2739
"Cleanup function; run on exit"
1957
2740
service.cleanup()
1958
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
1959
2798
while tcp_server.clients:
1960
client = tcp_server.clients.pop()
2799
name, client = tcp_server.clients.popitem()
1961
2800
if use_dbus:
1962
2801
client.remove_from_connection()
1963
client.disable_hook = None
1964
2802
# Don't signal anything except ClientRemoved
1965
2803
client.disable(quiet=True)
1966
2804
if use_dbus:
1967
2805
# Emit D-Bus signal
1968
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2806
mandos_dbus_service.ClientRemoved(client
2807
.dbus_object_path,
1969
2808
client.name)
2809
client_settings.clear()
1970
2810
1971
2811
atexit.register(cleanup)
1972
2812
1973
for client in tcp_server.clients:
2813
for client in tcp_server.clients.itervalues():
1974
2814
if use_dbus:
1975
2815
# Emit D-Bus signal
1976
2816
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1977
client.enable()
2817
# Need to initiate checking of clients
2818
if client.enabled:
2819
client.init_checker()
1978
2820
1979
2821
tcp_server.enable()
1980
2822
tcp_server.server_activate()
1982
2824
# Find out what port we got
1983
2825
service.port = tcp_server.socket.getsockname()[1]
1984
2826
if use_ipv6:
1985
logger.info(u"Now listening on address %r, port %d,"
1986
" flowinfo %d, scope_id %d"
1987
% 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())
1988
2830
else: # IPv4
1989
logger.info(u"Now listening on address %r, port %d"
1990
% tcp_server.socket.getsockname())
2831
logger.info("Now listening on address %r, port %d",
2832
*tcp_server.socket.getsockname())
1991
2833
1992
2834
#service.interface = tcp_server.socket.getsockname()[3]
1993
2835
1995
2837
# From the Avahi example code
1996
2838
try:
1997
2839
service.activate()
1998
except dbus.exceptions.DBusException, error:
1999
logger.critical(u"DBusException: %s", error)
2840
except dbus.exceptions.DBusException as error:
2841
logger.critical("D-Bus Exception", exc_info=error)
2000
2842
cleanup()
2001
2843
sys.exit(1)
2002
2844
# End of Avahi example code
2006
2848
(tcp_server.handle_request
2007
2849
(*args[2:], **kwargs) or True))
2008
2850
2009
logger.debug(u"Starting main loop")
2851
logger.debug("Starting main loop")
2010
2852
main_loop.run()
2011
except AvahiError, error:
2012
logger.critical(u"AvahiError: %s", error)
2853
except AvahiError as error:
2854
logger.critical("Avahi Error", exc_info=error)
2013
2855
cleanup()
2014
2856
sys.exit(1)
2015
2857
except KeyboardInterrupt:
2016
2858
if debug:
2017
print >> sys.stderr
2018
logger.debug(u"Server received KeyboardInterrupt")
2019
logger.debug(u"Server exiting")
2859
print("", file=sys.stderr)
2860
logger.debug("Server received KeyboardInterrupt")
2861
logger.debug("Server exiting")
2020
2862
# Must run before the D-Bus bus name gets deregistered
2021
2863
cleanup()
2022
2864
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0