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 441
- compare with another revision
- download diff
- download tarball
- view history from revision 441
- Committer: Teddy Hogeborn
- Date: 2010-09-25 23:52:17 UTC
- Revision ID: teddy@fukt.bsnet.se-20100925235217-4hhqfryz1ste6uw3
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
to "_" in D-Bus object paths.
(MandosServer.handle_ipc): Bug fix: Send only address string to
D-Bus signal, not whole tuple.
* mandos-ctl: New options "--approve-by-default", "--deny-by-default",
"--approval-delay", and "--approval-duration".
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new options.
* mandos-monitor (MandosClientWidget.update): Fix spelling.
to "_" in D-Bus object paths.
(MandosServer.handle_ipc): Bug fix: Send only address string to
D-Bus signal, not whole tuple.
* mandos-ctl: New options "--approve-by-default", "--deny-by-default",
"--approval-delay", and "--approval-duration".
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new options.
* mandos-monitor (MandosClientWidget.update): Fix spelling.
- files removed:
- 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-2013 Teddy Hogeborn
15
# Copyright © 2008-2013 Björn Påhlsson
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 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@recompile.se>.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
#
33
33
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
34
from __future__ import division, with_statement, absolute_import
38
35
39
36
import SocketServer as socketserver
40
37
import socket
41
import argparse
38
import optparse
42
39
import datetime
43
40
import errno
44
41
import gnutls.crypto
64
61
import functools
65
62
import cPickle as pickle
66
63
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
72
64
73
65
import dbus
74
66
import dbus.service
88
80
except ImportError:
89
81
SO_BINDTODEVICE = None
90
82
91
version = "1.6.2"
92
stored_state_file = "clients.pickle"
93
94
logger = logging.getLogger()
83
84
version = "1.0.14"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
95
88
syslogger = (logging.handlers.SysLogHandler
96
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
address = str("/dev/log")))
98
99
try:
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
102
.if_nametoindex)
103
except (OSError, AttributeError):
104
def if_nametoindex(interface):
105
"Get an interface index the hard way, i.e. using fcntl()"
106
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
107
with contextlib.closing(socket.socket()) as s:
108
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
struct.pack(str("16s16x"),
110
interface))
111
interface_index = struct.unpack(str("I"),
112
ifreq[16:20])[0]
113
return interface_index
114
115
116
def initlogger(debug, level=logging.WARNING):
117
"""init logger and add loglevel"""
118
119
syslogger.setFormatter(logging.Formatter
120
('Mandos [%(process)d]: %(levelname)s:'
121
' %(message)s'))
122
logger.addHandler(syslogger)
123
124
if debug:
125
console = logging.StreamHandler()
126
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
127
' [%(process)d]:'
128
' %(levelname)s:'
129
' %(message)s'))
130
logger.addHandler(console)
131
logger.setLevel(level)
132
133
134
class PGPError(Exception):
135
"""Exception if encryption/decryption fails"""
136
pass
137
138
139
class PGPEngine(object):
140
"""A simple class for OpenPGP symmetric encryption & decryption"""
141
def __init__(self):
142
self.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
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)
220
101
221
102
class AvahiError(Exception):
222
103
def __init__(self, value, *args, **kwargs):
238
119
Attributes:
239
120
interface: integer; avahi.IF_UNSPEC or an interface index.
240
121
Used to optionally bind to the specified interface.
241
name: string; Example: 'Mandos'
242
type: string; Example: '_mandos._tcp'.
243
See <https://www.iana.org/assignments/service-names-port-numbers>
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
244
125
port: integer; what port to announce
245
126
TXT: list of strings; TXT record for the service
246
127
domain: string; Domain to publish on, default to .local if empty.
252
133
server: D-Bus Server
253
134
bus: dbus.SystemBus()
254
135
"""
255
256
136
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
257
137
servicetype = None, port = None, TXT = None,
258
domain = "", host = "", max_renames = 32768,
138
domain = u"", host = u"", max_renames = 32768,
259
139
protocol = avahi.PROTO_UNSPEC, bus = None):
260
140
self.interface = interface
261
141
self.name = name
270
150
self.group = None # our entry group
271
151
self.server = None
272
152
self.bus = bus
273
self.entry_group_state_changed_match = None
274
275
153
def rename(self):
276
154
"""Derived from the Avahi example code"""
277
155
if self.rename_count >= self.max_renames:
278
logger.critical("No suitable Zeroconf service name found"
279
" after %i retries, exiting.",
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
280
158
self.rename_count)
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 ...",
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 ...",
285
162
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
286
167
self.remove()
287
168
try:
288
169
self.add()
289
except dbus.exceptions.DBusException as error:
290
logger.critical("D-Bus Exception", exc_info=error)
170
except dbus.exceptions.DBusException, error:
171
logger.critical(u"DBusException: %s", error)
291
172
self.cleanup()
292
173
os._exit(1)
293
174
self.rename_count += 1
294
295
175
def remove(self):
296
176
"""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
300
177
if self.group is not None:
301
178
self.group.Reset()
302
303
179
def add(self):
304
180
"""Derived from the Avahi example code"""
305
self.remove()
306
181
if self.group is None:
307
182
self.group = dbus.Interface(
308
183
self.bus.get_object(avahi.DBUS_NAME,
309
184
self.server.EntryGroupNew()),
310
185
avahi.DBUS_INTERFACE_ENTRY_GROUP)
311
self.entry_group_state_changed_match = (
312
self.group.connect_to_signal(
313
'StateChanged', self.entry_group_state_changed))
314
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
186
self.group.connect_to_signal('StateChanged',
187
self
188
.entry_group_state_changed)
189
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
315
190
self.name, self.type)
316
191
self.group.AddService(
317
192
self.interface,
322
197
dbus.UInt16(self.port),
323
198
avahi.string_array_to_txt_array(self.TXT))
324
199
self.group.Commit()
325
326
200
def entry_group_state_changed(self, state, error):
327
201
"""Derived from the Avahi example code"""
328
logger.debug("Avahi entry group state change: %i", state)
202
logger.debug(u"Avahi entry group state change: %i", state)
329
203
330
204
if state == avahi.ENTRY_GROUP_ESTABLISHED:
331
logger.debug("Zeroconf service established.")
205
logger.debug(u"Zeroconf service established.")
332
206
elif state == avahi.ENTRY_GROUP_COLLISION:
333
logger.info("Zeroconf service name collision.")
207
logger.warning(u"Zeroconf service name collision.")
334
208
self.rename()
335
209
elif state == avahi.ENTRY_GROUP_FAILURE:
336
logger.critical("Avahi: Error in group state changed %s",
210
logger.critical(u"Avahi: Error in group state changed %s",
337
211
unicode(error))
338
raise AvahiGroupError("State changed: {0!s}"
339
.format(error))
340
212
raise AvahiGroupError(u"State changed: %s"
213
% unicode(error))
341
214
def cleanup(self):
342
215
"""Derived from the Avahi example code"""
343
216
if self.group is not None:
344
try:
345
self.group.Free()
346
except (dbus.exceptions.UnknownMethodException,
347
dbus.exceptions.DBusException):
348
pass
217
self.group.Free()
349
218
self.group = None
350
self.remove()
351
352
def server_state_changed(self, state, error=None):
219
def server_state_changed(self, state):
353
220
"""Derived from the Avahi example code"""
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()
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()
369
225
elif state == avahi.SERVER_RUNNING:
370
226
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
377
227
def activate(self):
378
228
"""Derived from the Avahi example code"""
379
229
if self.server is None:
380
230
self.server = dbus.Interface(
381
231
self.bus.get_object(avahi.DBUS_NAME,
382
avahi.DBUS_PATH_SERVER,
383
follow_name_owner_changes=True),
232
avahi.DBUS_PATH_SERVER),
384
233
avahi.DBUS_INTERFACE_SERVER)
385
self.server.connect_to_signal("StateChanged",
234
self.server.connect_to_signal(u"StateChanged",
386
235
self.server_state_changed)
387
236
self.server_state_changed(self.server.GetState())
388
237
389
238
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
408
239
class Client(object):
409
240
"""A representation of a client host served by this server.
410
241
411
242
Attributes:
412
approved: bool(); 'None' if not yet approved/disapproved
243
_approved: bool(); 'None' if not yet approved/disapproved
413
244
approval_delay: datetime.timedelta(); Time to wait for approval
414
245
approval_duration: datetime.timedelta(); Duration of one approval
415
246
checker: subprocess.Popen(); a running checker process used
416
247
to see if the client lives.
417
248
'None' if no process is running.
418
checker_callback_tag: a gobject event source tag, or None
249
checker_callback_tag: - '' -
419
250
checker_command: string; External command which is run to check
420
251
if client lives. %() expansions are done at
421
252
runtime with vars(self) as dict, so that for
422
253
instance %(name)s can be used in the command.
423
254
checker_initiator_tag: a gobject event source tag, or None
424
255
created: datetime.datetime(); (UTC) object creation
425
client_structure: Object describing what attributes a client has
426
and is used for storing the client at exit
427
256
current_checker_command: string; current running checker_command
428
disable_initiator_tag: a gobject event source tag, or None
257
disable_hook: If set, called by disable() as disable_hook(self)
258
disable_initiator_tag: - '' -
429
259
enabled: bool()
430
260
fingerprint: string (40 or 32 hexadecimal digits); used to
431
261
uniquely identify the client
432
262
host: string; available for use by the checker command
433
263
interval: datetime.timedelta(); How often to start a new checker
434
last_approval_request: datetime.datetime(); (UTC) or None
435
264
last_checked_ok: datetime.datetime(); (UTC) or None
436
last_checker_status: integer between 0 and 255 reflecting exit
437
status of last checker. -1 reflects crashed
438
checker, -2 means no checker completed yet.
439
last_enabled: datetime.datetime(); (UTC) or None
265
last_enabled: datetime.datetime(); (UTC)
440
266
name: string; from the config file, used in log messages and
441
267
D-Bus identifiers
442
268
secret: bytestring; sent verbatim (over TLS) to client
443
269
timeout: datetime.timedelta(); How long from last_checked_ok
444
270
until this client is disabled
445
extended_timeout: extra long timeout when secret has been sent
446
271
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()
450
272
"""
451
273
452
runtime_expansions = ("approval_delay", "approval_duration",
453
"created", "enabled", "expires",
454
"fingerprint", "host", "interval",
455
"last_approval_request", "last_checked_ok",
456
"last_enabled", "name", "timeout")
457
client_defaults = { "timeout": "PT5M",
458
"extended_timeout": "PT15M",
459
"interval": "PT2M",
460
"checker": "fping -q -- %%(host)s",
461
"host": "",
462
"approval_delay": "PT0S",
463
"approval_duration": "PT1S",
464
"approved_by_default": "True",
465
"enabled": "True",
466
}
274
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))
467
285
468
286
def timeout_milliseconds(self):
469
287
"Return the 'timeout' attribute in milliseconds"
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)
288
return self._timedelta_to_milliseconds(self.timeout)
475
289
476
290
def interval_milliseconds(self):
477
291
"Return the 'interval' attribute in milliseconds"
478
return timedelta_to_milliseconds(self.interval)
479
292
return self._timedelta_to_milliseconds(self.interval)
293
480
294
def approval_delay_milliseconds(self):
481
return timedelta_to_milliseconds(self.approval_delay)
482
483
@staticmethod
484
def config_parser(config):
485
"""Construct a new dict of client settings of this form:
486
{ client_name: {setting_name: value, ...}, ...}
487
with exceptions for any special settings as defined above.
488
NOTE: Must be a pure function. Must return the same result
489
value given the same arguments.
490
"""
491
settings = {}
492
for client_name in config.sections():
493
section = dict(config.items(client_name))
494
client = settings[client_name] = {}
495
496
client["host"] = section["host"]
497
# Reformat values from string types to Python types
498
client["approved_by_default"] = config.getboolean(
499
client_name, "approved_by_default")
500
client["enabled"] = config.getboolean(client_name,
501
"enabled")
502
503
client["fingerprint"] = (section["fingerprint"].upper()
504
.replace(" ", ""))
505
if "secret" in section:
506
client["secret"] = section["secret"].decode("base64")
507
elif "secfile" in section:
508
with open(os.path.expanduser(os.path.expandvars
509
(section["secfile"])),
510
"rb") as secfile:
511
client["secret"] = secfile.read()
512
else:
513
raise TypeError("No secret or secfile for section {0}"
514
.format(section))
515
client["timeout"] = string_to_delta(section["timeout"])
516
client["extended_timeout"] = string_to_delta(
517
section["extended_timeout"])
518
client["interval"] = string_to_delta(section["interval"])
519
client["approval_delay"] = string_to_delta(
520
section["approval_delay"])
521
client["approval_duration"] = string_to_delta(
522
section["approval_duration"])
523
client["checker_command"] = section["checker"]
524
client["last_approval_request"] = None
525
client["last_checked_ok"] = None
526
client["last_checker_status"] = -2
527
528
return settings
529
530
def __init__(self, settings, name = None, server_settings=None):
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."""
531
301
self.name = 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)
302
if config is None:
303
config = {}
304
logger.debug(u"Creating client %r", self.name)
550
305
# Uppercase and remove spaces from fingerprint for later
551
306
# comparison purposes with return value from the fingerprint()
552
307
# function
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
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
558
329
self.checker = None
559
330
self.checker_initiator_tag = None
560
331
self.disable_initiator_tag = None
561
332
self.checker_callback_tag = None
333
self.checker_command = config[u"checker"]
562
334
self.current_checker_command = None
563
self.approved = None
335
self.last_connect = None
336
self._approved = None
337
self.approved_by_default = config.get(u"approved_by_default",
338
True)
564
339
self.approvals_pending = 0
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)
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())
579
345
580
# Send notice to process children that client state has changed
581
346
def send_changedstate(self):
582
with self.changedstate:
583
self.changedstate.notify_all()
584
347
self.changedstate.acquire()
348
self.changedstate.notify_all()
349
self.changedstate.release()
350
585
351
def enable(self):
586
352
"""Start this client's checker and timeout hooks"""
587
if getattr(self, "enabled", False):
353
if getattr(self, u"enabled", False):
588
354
# Already enabled
589
355
return
590
self.expires = datetime.datetime.utcnow() + self.timeout
591
self.enabled = True
356
self.send_changedstate()
592
357
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):
620
358
# Schedule a new checker to be started an 'interval' from now,
621
359
# and every interval from then on.
622
if self.checker_initiator_tag is not None:
623
gobject.source_remove(self.checker_initiator_tag)
624
360
self.checker_initiator_tag = (gobject.timeout_add
625
361
(self.interval_milliseconds(),
626
362
self.start_checker))
627
363
# Schedule a disable() when 'timeout' has passed
628
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
630
364
self.disable_initiator_tag = (gobject.timeout_add
631
365
(self.timeout_milliseconds(),
632
366
self.disable))
367
self.enabled = True
633
368
# Also start a new checker *right now*.
634
369
self.start_checker()
635
370
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
636
396
def checker_callback(self, pid, condition, command):
637
397
"""The checker has completed, so take appropriate actions."""
638
398
self.checker_callback_tag = None
639
399
self.checker = None
640
400
if os.WIFEXITED(condition):
641
self.last_checker_status = os.WEXITSTATUS(condition)
642
if self.last_checker_status == 0:
643
logger.info("Checker for %(name)s succeeded",
401
exitstatus = os.WEXITSTATUS(condition)
402
if exitstatus == 0:
403
logger.info(u"Checker for %(name)s succeeded",
644
404
vars(self))
645
405
self.checked_ok()
646
406
else:
647
logger.info("Checker for %(name)s failed",
407
logger.info(u"Checker for %(name)s failed",
648
408
vars(self))
649
409
else:
650
self.last_checker_status = -1
651
logger.warning("Checker for %(name)s crashed?",
410
logger.warning(u"Checker for %(name)s crashed?",
652
411
vars(self))
653
412
654
413
def checked_ok(self):
655
"""Assert that the client has been seen, alive and well."""
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
"""
656
419
self.last_checked_ok = datetime.datetime.utcnow()
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()
420
gobject.source_remove(self.disable_initiator_tag)
421
self.disable_initiator_tag = (gobject.timeout_add
422
(self.timeout_milliseconds(),
423
self.disable))
675
424
676
425
def start_checker(self):
677
426
"""Start a new checker subprocess if one is not running.
679
428
If a checker already exists, leave it running and do
680
429
nothing."""
681
430
# The reason for not killing a running checker is that if we
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
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
686
435
# checkers alone, the checker would have to take more time
687
436
# than 'timeout' for the client to be disabled, which is as it
688
437
# should be.
690
439
# If a checker exists, make sure it is not a zombie
691
440
try:
692
441
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
693
except (AttributeError, OSError) as error:
442
except (AttributeError, OSError), error:
694
443
if (isinstance(error, OSError)
695
444
and error.errno != errno.ECHILD):
696
445
raise error
697
446
else:
698
447
if pid:
699
logger.warning("Checker was a zombie")
448
logger.warning(u"Checker was a zombie")
700
449
gobject.source_remove(self.checker_callback_tag)
701
450
self.checker_callback(pid, status,
702
451
self.current_checker_command)
703
452
# Start a new checker if needed
704
453
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)
710
454
try:
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
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
716
473
self.current_checker_command = command
717
474
try:
718
logger.info("Starting checker %r for %s",
475
logger.info(u"Starting checker %r for %s",
719
476
command, self.name)
720
477
# We don't need to redirect stdout and stderr, since
721
478
# in normal mode, that is already done by daemon(),
722
479
# and in debug mode we don't want to. (Stdin is
723
480
# 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 })
732
481
self.checker = subprocess.Popen(command,
733
482
close_fds=True,
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:
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.
747
490
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
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)
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)
758
497
# Re-run this periodically if run by gobject.timeout_add
759
498
return True
760
499
763
502
if self.checker_callback_tag:
764
503
gobject.source_remove(self.checker_callback_tag)
765
504
self.checker_callback_tag = None
766
if getattr(self, "checker", None) is None:
505
if getattr(self, u"checker", None) is None:
767
506
return
768
logger.debug("Stopping checker for %(name)s", vars(self))
507
logger.debug(u"Stopping checker for %(name)s", vars(self))
769
508
try:
770
self.checker.terminate()
509
os.kill(self.checker.pid, signal.SIGTERM)
771
510
#time.sleep(0.5)
772
511
#if self.checker.poll() is None:
773
# self.checker.kill()
774
except OSError as error:
512
# os.kill(self.checker.pid, signal.SIGKILL)
513
except OSError, error:
775
514
if error.errno != errno.ESRCH: # No such process
776
515
raise
777
516
self.checker = None
778
517
779
780
def dbus_service_property(dbus_interface, signature="v",
781
access="readwrite", byte_arrays=False):
518
def dbus_service_property(dbus_interface, signature=u"v",
519
access=u"readwrite", byte_arrays=False):
782
520
"""Decorators for marking methods of a DBusObjectWithProperties to
783
521
become properties on the D-Bus.
784
522
791
529
"""
792
530
# Encoding deeply encoded byte arrays is not supported yet by the
793
531
# "Set" method, so we fail early here:
794
if byte_arrays and signature != "ay":
795
raise ValueError("Byte arrays not supported for non-'ay'"
796
" signature {0!r}".format(signature))
532
if byte_arrays and signature != u"ay":
533
raise ValueError(u"Byte arrays not supported for non-'ay'"
534
u" signature %r" % signature)
797
535
def decorator(func):
798
536
func._dbus_is_property = True
799
537
func._dbus_interface = dbus_interface
800
538
func._dbus_signature = signature
801
539
func._dbus_access = access
802
540
func._dbus_name = func.__name__
803
if func._dbus_name.endswith("_dbus_property"):
541
if func._dbus_name.endswith(u"_dbus_property"):
804
542
func._dbus_name = func._dbus_name[:-14]
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
543
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
843
544
return func
844
545
return decorator
845
546
865
566
866
567
class DBusObjectWithProperties(dbus.service.Object):
867
568
"""A D-Bus object with properties.
868
569
869
570
Classes inheriting from this can use the dbus_service_property
870
571
decorator to expose methods as D-Bus properties. It exposes the
871
572
standard Get(), Set(), and GetAll() methods on the D-Bus.
872
573
"""
873
574
874
575
@staticmethod
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)
576
def _is_dbus_property(obj):
577
return getattr(obj, u"_dbus_is_property", False)
883
578
884
def _get_all_dbus_things(self, thing):
579
def _get_all_dbus_properties(self):
885
580
"""Returns a generator of (name, attribute) pairs
886
581
"""
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)))
582
return ((prop._dbus_name, prop)
583
for name, prop in
584
inspect.getmembers(self, self._is_dbus_property))
894
585
895
586
def _get_dbus_property(self, interface_name, property_name):
896
587
"""Returns a bound method if one exists which is a D-Bus
897
588
property with the specified name and interface.
898
589
"""
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
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
907
600
# No such property
908
raise DBusPropertyNotFound(self.dbus_object_path + ":"
909
+ interface_name + "."
601
raise DBusPropertyNotFound(self.dbus_object_path + u":"
602
+ interface_name + u"."
910
603
+ property_name)
911
604
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
913
out_signature="v")
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
606
out_signature=u"v")
914
607
def Get(self, interface_name, property_name):
915
608
"""Standard D-Bus property Get() method, see D-Bus standard.
916
609
"""
917
610
prop = self._get_dbus_property(interface_name, property_name)
918
if prop._dbus_access == "write":
611
if prop._dbus_access == u"write":
919
612
raise DBusPropertyAccessException(property_name)
920
613
value = prop()
921
if not hasattr(value, "variant_level"):
614
if not hasattr(value, u"variant_level"):
922
615
return value
923
616
return type(value)(value, variant_level=value.variant_level+1)
924
617
925
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
618
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
926
619
def Set(self, interface_name, property_name, value):
927
620
"""Standard D-Bus property Set() method, see D-Bus standard.
928
621
"""
929
622
prop = self._get_dbus_property(interface_name, property_name)
930
if prop._dbus_access == "read":
623
if prop._dbus_access == u"read":
931
624
raise DBusPropertyAccessException(property_name)
932
if prop._dbus_get_args_options["byte_arrays"]:
625
if prop._dbus_get_args_options[u"byte_arrays"]:
933
626
# The byte_arrays option is not supported yet on
934
627
# signatures other than "ay".
935
if prop._dbus_signature != "ay":
628
if prop._dbus_signature != u"ay":
936
629
raise ValueError
937
value = dbus.ByteArray(b''.join(chr(byte)
938
for byte in value))
630
value = dbus.ByteArray(''.join(unichr(byte)
631
for byte in value))
939
632
prop(value)
940
633
941
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
942
out_signature="a{sv}")
634
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
635
out_signature=u"a{sv}")
943
636
def GetAll(self, interface_name):
944
637
"""Standard D-Bus property GetAll() method, see D-Bus
945
638
standard.
946
639
947
640
Note: Will not include properties with access="write".
948
641
"""
949
properties = {}
950
for name, prop in self._get_all_dbus_things("property"):
642
all = {}
643
for name, prop in self._get_all_dbus_properties():
951
644
if (interface_name
952
645
and interface_name != prop._dbus_interface):
953
646
# Interface non-empty but did not match
954
647
continue
955
648
# Ignore write-only properties
956
if prop._dbus_access == "write":
649
if prop._dbus_access == u"write":
957
650
continue
958
651
value = prop()
959
if not hasattr(value, "variant_level"):
960
properties[name] = value
652
if not hasattr(value, u"variant_level"):
653
all[name] = value
961
654
continue
962
properties[name] = type(value)(value, variant_level=
963
value.variant_level+1)
964
return dbus.Dictionary(properties, signature="sv")
655
all[name] = type(value)(value, variant_level=
656
value.variant_level+1)
657
return dbus.Dictionary(all, signature=u"sv")
965
658
966
659
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
967
out_signature="s",
660
out_signature=u"s",
968
661
path_keyword='object_path',
969
662
connection_keyword='connection')
970
663
def Introspect(self, object_path, connection):
971
"""Overloading of standard D-Bus method.
972
973
Inserts property tags and interface annotation tags.
664
"""Standard D-Bus method, overloaded to insert property tags.
974
665
"""
975
666
xmlstring = dbus.service.Object.Introspect(self, object_path,
976
667
connection)
977
668
try:
978
669
document = xml.dom.minidom.parseString(xmlstring)
979
670
def make_tag(document, name, prop):
980
e = document.createElement("property")
981
e.setAttribute("name", name)
982
e.setAttribute("type", prop._dbus_signature)
983
e.setAttribute("access", prop._dbus_access)
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)
984
675
return e
985
for if_tag in document.getElementsByTagName("interface"):
986
# Add property tags
676
for if_tag in document.getElementsByTagName(u"interface"):
987
677
for tag in (make_tag(document, name, prop)
988
678
for name, prop
989
in self._get_all_dbus_things("property")
679
in self._get_all_dbus_properties()
990
680
if prop._dbus_interface
991
== if_tag.getAttribute("name")):
681
== if_tag.getAttribute(u"name")):
992
682
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)
1024
683
# Add the names to the return values for the
1025
684
# "org.freedesktop.DBus.Properties" methods
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")
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")
1040
699
document.unlink()
1041
700
except (AttributeError, xml.dom.DOMException,
1042
xml.parsers.expat.ExpatError) as error:
1043
logger.error("Failed to override Introspection method",
1044
exc_info=error)
701
xml.parsers.expat.ExpatError), error:
702
logger.error(u"Failed to override Introspection method",
703
error)
1045
704
return xmlstring
1046
705
1047
706
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"})
1227
707
class ClientDBus(Client, DBusObjectWithProperties):
1228
708
"""A Client class using D-Bus
1229
709
1233
713
"""
1234
714
1235
715
runtime_expansions = (Client.runtime_expansions
1236
+ ("dbus_object_path",))
716
+ (u"dbus_object_path",))
1237
717
1238
718
# dbus.service.Object doesn't use super(), so we can't either.
1239
719
1240
720
def __init__(self, bus = None, *args, **kwargs):
721
self._approvals_pending = 0
1241
722
self.bus = bus
1242
723
Client.__init__(self, *args, **kwargs)
1243
724
# Only now, when this client is initialized, can it show up on
1244
725
# the D-Bus
1245
726
client_object_name = unicode(self.name).translate(
1246
{ord("."): ord("_"),
1247
ord("-"): ord("_")})
727
{ord(u"."): ord(u"_"),
728
ord(u"-"): ord(u"_")})
1248
729
self.dbus_object_path = (dbus.ObjectPath
1249
("/clients/" + client_object_name))
730
(u"/clients/" + client_object_name))
1250
731
DBusObjectWithProperties.__init__(self, self.bus,
1251
732
self.dbus_object_path)
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
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
1320
777
1321
778
def __del__(self, *args, **kwargs):
1322
779
try:
1323
780
self.remove_from_connection()
1324
781
except LookupError:
1325
782
pass
1326
if hasattr(DBusObjectWithProperties, "__del__"):
783
if hasattr(DBusObjectWithProperties, u"__del__"):
1327
784
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1328
785
Client.__del__(self, *args, **kwargs)
1329
786
1331
788
*args, **kwargs):
1332
789
self.checker_callback_tag = None
1333
790
self.checker = None
791
# Emit D-Bus signal
792
self.PropertyChanged(dbus.String(u"CheckerRunning"),
793
dbus.Boolean(False, variant_level=1))
1334
794
if os.WIFEXITED(condition):
1335
795
exitstatus = os.WEXITSTATUS(condition)
1336
796
# Emit D-Bus signal
1346
806
return Client.checker_callback(self, pid, condition, command,
1347
807
*args, **kwargs)
1348
808
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
1349
818
def start_checker(self, *args, **kwargs):
1350
819
old_checker = self.checker
1351
820
if self.checker is not None:
1358
827
and old_checker_pid != self.checker.pid):
1359
828
# Emit D-Bus signal
1360
829
self.CheckerStarted(self.current_checker_command)
830
self.PropertyChanged(
831
dbus.String(u"CheckerRunning"),
832
dbus.Boolean(True, variant_level=1))
1361
833
return r
1362
834
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
1363
844
def _reset_approved(self):
1364
self.approved = None
845
self._approved = None
1365
846
return False
1366
847
1367
848
def approve(self, value=True):
1368
self.approved = value
1369
gobject.timeout_add(timedelta_to_milliseconds
849
self.send_changedstate()
850
self._approved = value
851
gobject.timeout_add(self._timedelta_to_milliseconds
1370
852
(self.approval_duration),
1371
853
self._reset_approved)
1372
self.send_changedstate()
854
1373
855
1374
856
## D-Bus methods, signals & properties
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"}
857
_interface = u"se.bsnet.fukt.Mandos.Client"
1383
858
1384
859
## Signals
1385
860
1386
861
# CheckerCompleted - signal
1387
@dbus.service.signal(_interface, signature="nxs")
862
@dbus.service.signal(_interface, signature=u"nxs")
1388
863
def CheckerCompleted(self, exitcode, waitstatus, command):
1389
864
"D-Bus signal"
1390
865
pass
1391
866
1392
867
# CheckerStarted - signal
1393
@dbus.service.signal(_interface, signature="s")
868
@dbus.service.signal(_interface, signature=u"s")
1394
869
def CheckerStarted(self, command):
1395
870
"D-Bus signal"
1396
871
pass
1397
872
1398
873
# PropertyChanged - signal
1399
@dbus.service.signal(_interface, signature="sv")
874
@dbus.service.signal(_interface, signature=u"sv")
1400
875
def PropertyChanged(self, property, value):
1401
876
"D-Bus signal"
1402
877
pass
1411
886
pass
1412
887
1413
888
# Rejected - signal
1414
@dbus.service.signal(_interface, signature="s")
889
@dbus.service.signal(_interface, signature=u"s")
1415
890
def Rejected(self, reason):
1416
891
"D-Bus signal"
1417
892
pass
1418
893
1419
894
# NeedApproval - signal
1420
@dbus.service.signal(_interface, signature="tb")
895
@dbus.service.signal(_interface, signature=u"tb")
1421
896
def NeedApproval(self, timeout, default):
1422
897
"D-Bus signal"
1423
return self.need_approval()
898
pass
1424
899
1425
900
## Methods
1426
901
1427
902
# Approve - method
1428
@dbus.service.method(_interface, in_signature="b")
903
@dbus.service.method(_interface, in_signature=u"b")
1429
904
def Approve(self, value):
1430
905
self.approve(value)
1431
906
1432
907
# CheckedOK - method
1433
908
@dbus.service.method(_interface)
1434
909
def CheckedOK(self):
1435
self.checked_ok()
910
return self.checked_ok()
1436
911
1437
912
# Enable - method
1438
913
@dbus.service.method(_interface)
1460
935
## Properties
1461
936
1462
937
# ApprovalPending - property
1463
@dbus_service_property(_interface, signature="b", access="read")
938
@dbus_service_property(_interface, signature=u"b", access=u"read")
1464
939
def ApprovalPending_dbus_property(self):
1465
940
return dbus.Boolean(bool(self.approvals_pending))
1466
941
1467
942
# ApprovedByDefault - property
1468
@dbus_service_property(_interface, signature="b",
1469
access="readwrite")
943
@dbus_service_property(_interface, signature=u"b",
944
access=u"readwrite")
1470
945
def ApprovedByDefault_dbus_property(self, value=None):
1471
946
if value is None: # get
1472
947
return dbus.Boolean(self.approved_by_default)
1473
948
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))
1474
952
1475
953
# ApprovalDelay - property
1476
@dbus_service_property(_interface, signature="t",
1477
access="readwrite")
954
@dbus_service_property(_interface, signature=u"t",
955
access=u"readwrite")
1478
956
def ApprovalDelay_dbus_property(self, value=None):
1479
957
if value is None: # get
1480
958
return dbus.UInt64(self.approval_delay_milliseconds())
1481
959
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))
1482
963
1483
964
# ApprovalDuration - property
1484
@dbus_service_property(_interface, signature="t",
1485
access="readwrite")
965
@dbus_service_property(_interface, signature=u"t",
966
access=u"readwrite")
1486
967
def ApprovalDuration_dbus_property(self, value=None):
1487
968
if value is None: # get
1488
return dbus.UInt64(timedelta_to_milliseconds(
969
return dbus.UInt64(self._timedelta_to_milliseconds(
1489
970
self.approval_duration))
1490
971
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))
1491
975
1492
976
# Name - property
1493
@dbus_service_property(_interface, signature="s", access="read")
977
@dbus_service_property(_interface, signature=u"s", access=u"read")
1494
978
def Name_dbus_property(self):
1495
979
return dbus.String(self.name)
1496
980
1497
981
# Fingerprint - property
1498
@dbus_service_property(_interface, signature="s", access="read")
982
@dbus_service_property(_interface, signature=u"s", access=u"read")
1499
983
def Fingerprint_dbus_property(self):
1500
984
return dbus.String(self.fingerprint)
1501
985
1502
986
# Host - property
1503
@dbus_service_property(_interface, signature="s",
1504
access="readwrite")
987
@dbus_service_property(_interface, signature=u"s",
988
access=u"readwrite")
1505
989
def Host_dbus_property(self, value=None):
1506
990
if value is None: # get
1507
991
return dbus.String(self.host)
1508
self.host = unicode(value)
992
self.host = value
993
# Emit D-Bus signal
994
self.PropertyChanged(dbus.String(u"Host"),
995
dbus.String(value, variant_level=1))
1509
996
1510
997
# Created - property
1511
@dbus_service_property(_interface, signature="s", access="read")
998
@dbus_service_property(_interface, signature=u"s", access=u"read")
1512
999
def Created_dbus_property(self):
1513
return datetime_to_dbus(self.created)
1000
return dbus.String(self._datetime_to_dbus(self.created))
1514
1001
1515
1002
# LastEnabled - property
1516
@dbus_service_property(_interface, signature="s", access="read")
1003
@dbus_service_property(_interface, signature=u"s", access=u"read")
1517
1004
def LastEnabled_dbus_property(self):
1518
return datetime_to_dbus(self.last_enabled)
1005
if self.last_enabled is None:
1006
return dbus.String(u"")
1007
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1519
1008
1520
1009
# Enabled - property
1521
@dbus_service_property(_interface, signature="b",
1522
access="readwrite")
1010
@dbus_service_property(_interface, signature=u"b",
1011
access=u"readwrite")
1523
1012
def Enabled_dbus_property(self, value=None):
1524
1013
if value is None: # get
1525
1014
return dbus.Boolean(self.enabled)
1529
1018
self.disable()
1530
1019
1531
1020
# LastCheckedOK - property
1532
@dbus_service_property(_interface, signature="s",
1533
access="readwrite")
1021
@dbus_service_property(_interface, signature=u"s",
1022
access=u"readwrite")
1534
1023
def LastCheckedOK_dbus_property(self, value=None):
1535
1024
if value is not None:
1536
1025
self.checked_ok()
1537
1026
return
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)
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))
1555
1031
1556
1032
# Timeout - property
1557
@dbus_service_property(_interface, signature="t",
1558
access="readwrite")
1033
@dbus_service_property(_interface, signature=u"t",
1034
access=u"readwrite")
1559
1035
def Timeout_dbus_property(self, value=None):
1560
1036
if value is None: # get
1561
1037
return dbus.UInt64(self.timeout_milliseconds())
1562
old_timeout = self.timeout
1563
1038
self.timeout = datetime.timedelta(0, 0, 0, value)
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)
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))
1588
1059
1589
1060
# Interval - property
1590
@dbus_service_property(_interface, signature="t",
1591
access="readwrite")
1061
@dbus_service_property(_interface, signature=u"t",
1062
access=u"readwrite")
1592
1063
def Interval_dbus_property(self, value=None):
1593
1064
if value is None: # get
1594
1065
return dbus.UInt64(self.interval_milliseconds())
1595
1066
self.interval = datetime.timedelta(0, 0, 0, value)
1596
if getattr(self, "checker_initiator_tag", None) is None:
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:
1597
1071
return
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
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
1605
1078
# Checker - property
1606
@dbus_service_property(_interface, signature="s",
1607
access="readwrite")
1079
@dbus_service_property(_interface, signature=u"s",
1080
access=u"readwrite")
1608
1081
def Checker_dbus_property(self, value=None):
1609
1082
if value is None: # get
1610
1083
return dbus.String(self.checker_command)
1611
self.checker_command = unicode(value)
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))
1612
1089
1613
1090
# CheckerRunning - property
1614
@dbus_service_property(_interface, signature="b",
1615
access="readwrite")
1091
@dbus_service_property(_interface, signature=u"b",
1092
access=u"readwrite")
1616
1093
def CheckerRunning_dbus_property(self, value=None):
1617
1094
if value is None: # get
1618
1095
return dbus.Boolean(self.checker is not None)
1622
1099
self.stop_checker()
1623
1100
1624
1101
# ObjectPath - property
1625
@dbus_service_property(_interface, signature="o", access="read")
1102
@dbus_service_property(_interface, signature=u"o", access=u"read")
1626
1103
def ObjectPath_dbus_property(self):
1627
1104
return self.dbus_object_path # is already a dbus.ObjectPath
1628
1105
1629
1106
# Secret = property
1630
@dbus_service_property(_interface, signature="ay",
1631
access="write", byte_arrays=True)
1107
@dbus_service_property(_interface, signature=u"ay",
1108
access=u"write", byte_arrays=True)
1632
1109
def Secret_dbus_property(self, value):
1633
1110
self.secret = str(value)
1634
1111
1641
1118
self._pipe.send(('init', fpr, address))
1642
1119
if not self._pipe.recv():
1643
1120
raise KeyError()
1644
1121
1645
1122
def __getattribute__(self, name):
1646
if name == '_pipe':
1123
if(name == '_pipe'):
1647
1124
return super(ProxyClient, self).__getattribute__(name)
1648
1125
self._pipe.send(('getattr', name))
1649
1126
data = self._pipe.recv()
1654
1131
self._pipe.send(('funcall', name, args, kwargs))
1655
1132
return self._pipe.recv()[1]
1656
1133
return func
1657
1134
1658
1135
def __setattr__(self, name, value):
1659
if name == '_pipe':
1136
if(name == '_pipe'):
1660
1137
return super(ProxyClient, self).__setattr__(name, value)
1661
1138
self._pipe.send(('setattr', name, value))
1662
1139
1669
1146
1670
1147
def handle(self):
1671
1148
with contextlib.closing(self.server.child_pipe) as child_pipe:
1672
logger.info("TCP connection from: %s",
1149
logger.info(u"TCP connection from: %s",
1673
1150
unicode(self.client_address))
1674
logger.debug("Pipe FD: %d",
1151
logger.debug(u"Pipe FD: %d",
1675
1152
self.server.child_pipe.fileno())
1676
1153
1677
1154
session = (gnutls.connection
1678
1155
.ClientSession(self.request,
1679
1156
gnutls.connection
1680
1157
.X509Credentials()))
1681
1158
1682
1159
# Note: gnutls.connection.X509Credentials is really a
1683
1160
# generic GnuTLS certificate credentials object so long as
1684
1161
# no X.509 keys are added to it. Therefore, we can use it
1685
1162
# here despite using OpenPGP certificates.
1686
1687
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1688
# "+AES-256-CBC", "+SHA1",
1689
# "+COMP-NULL", "+CTYPE-OPENPGP",
1690
# "+DHE-DSS"))
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"))
1691
1168
# Use a fallback default, since this MUST be set.
1692
1169
priority = self.server.gnutls_priority
1693
1170
if priority is None:
1694
priority = "NORMAL"
1171
priority = u"NORMAL"
1695
1172
(gnutls.library.functions
1696
1173
.gnutls_priority_set_direct(session._c_object,
1697
1174
priority, None))
1698
1175
1699
1176
# Start communication using the Mandos protocol
1700
1177
# Get protocol number
1701
1178
line = self.request.makefile().readline()
1702
logger.debug("Protocol version: %r", line)
1179
logger.debug(u"Protocol version: %r", line)
1703
1180
try:
1704
1181
if int(line.strip().split()[0]) > 1:
1705
1182
raise RuntimeError
1706
except (ValueError, IndexError, RuntimeError) as error:
1707
logger.error("Unknown protocol version: %s", error)
1183
except (ValueError, IndexError, RuntimeError), error:
1184
logger.error(u"Unknown protocol version: %s", error)
1708
1185
return
1709
1186
1710
1187
# Start GnuTLS connection
1711
1188
try:
1712
1189
session.handshake()
1713
except gnutls.errors.GNUTLSError as error:
1714
logger.warning("Handshake failed: %s", error)
1190
except gnutls.errors.GNUTLSError, error:
1191
logger.warning(u"Handshake failed: %s", error)
1715
1192
# Do not run session.bye() here: the session is not
1716
1193
# established. Just abandon the request.
1717
1194
return
1718
logger.debug("Handshake succeeded")
1719
1195
logger.debug(u"Handshake succeeded")
1196
1720
1197
approval_required = False
1721
1198
try:
1722
1199
try:
1723
1200
fpr = self.fingerprint(self.peer_certificate
1724
1201
(session))
1725
except (TypeError,
1726
gnutls.errors.GNUTLSError) as error:
1727
logger.warning("Bad certificate: %s", error)
1202
except (TypeError, gnutls.errors.GNUTLSError), error:
1203
logger.warning(u"Bad certificate: %s", error)
1728
1204
return
1729
logger.debug("Fingerprint: %s", fpr)
1730
1205
logger.debug(u"Fingerprint: %s", fpr)
1206
1731
1207
try:
1732
1208
client = ProxyClient(child_pipe, fpr,
1733
1209
self.client_address)
1741
1217
1742
1218
while True:
1743
1219
if not client.enabled:
1744
logger.info("Client %s is disabled",
1220
logger.warning(u"Client %s is disabled",
1745
1221
client.name)
1746
1222
if self.server.use_dbus:
1747
1223
# Emit D-Bus signal
1748
client.Rejected("Disabled")
1224
client.Rejected("Disabled")
1749
1225
return
1750
1226
1751
if client.approved or not client.approval_delay:
1227
if client._approved or not client.approval_delay:
1752
1228
#We are approved or approval is disabled
1753
1229
break
1754
elif client.approved is None:
1755
logger.info("Client %s needs approval",
1230
elif client._approved is None:
1231
logger.info(u"Client %s needs approval",
1756
1232
client.name)
1757
1233
if self.server.use_dbus:
1758
1234
# Emit D-Bus signal
1760
1236
client.approval_delay_milliseconds(),
1761
1237
client.approved_by_default)
1762
1238
else:
1763
logger.warning("Client %s was not approved",
1239
logger.warning(u"Client %s was not approved",
1764
1240
client.name)
1765
1241
if self.server.use_dbus:
1766
1242
# Emit D-Bus signal
1768
1244
return
1769
1245
1770
1246
#wait until timeout or approved
1247
#x = float(client._timedelta_to_milliseconds(delay))
1771
1248
time = datetime.datetime.now()
1772
1249
client.changedstate.acquire()
1773
client.changedstate.wait(
1774
float(timedelta_to_milliseconds(delay)
1775
/ 1000))
1250
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1776
1251
client.changedstate.release()
1777
1252
time2 = datetime.datetime.now()
1778
1253
if (time2 - time) >= delay:
1793
1268
while sent_size < len(client.secret):
1794
1269
try:
1795
1270
sent = session.send(client.secret[sent_size:])
1796
except gnutls.errors.GNUTLSError as error:
1797
logger.warning("gnutls send failed",
1798
exc_info=error)
1271
except (gnutls.errors.GNUTLSError), error:
1272
logger.warning("gnutls send failed")
1799
1273
return
1800
logger.debug("Sent: %d, remaining: %d",
1274
logger.debug(u"Sent: %d, remaining: %d",
1801
1275
sent, len(client.secret)
1802
1276
- (sent_size + sent))
1803
1277
sent_size += sent
1804
1805
logger.info("Sending secret to %s", client.name)
1806
# bump the timeout using extended_timeout
1807
client.bump_timeout(client.extended_timeout)
1278
1279
logger.info(u"Sending secret to %s", client.name)
1280
# bump the timeout as if seen
1281
client.checked_ok()
1808
1282
if self.server.use_dbus:
1809
1283
# Emit D-Bus signal
1810
1284
client.GotSecret()
1814
1288
client.approvals_pending -= 1
1815
1289
try:
1816
1290
session.bye()
1817
except gnutls.errors.GNUTLSError as error:
1818
logger.warning("GnuTLS bye failed",
1819
exc_info=error)
1291
except (gnutls.errors.GNUTLSError), error:
1292
logger.warning("GnuTLS bye failed")
1820
1293
1821
1294
@staticmethod
1822
1295
def peer_certificate(session):
1832
1305
.gnutls_certificate_get_peers
1833
1306
(session._c_object, ctypes.byref(list_size)))
1834
1307
if not bool(cert_list) and list_size.value != 0:
1835
raise gnutls.errors.GNUTLSError("error getting peer"
1836
" certificate")
1308
raise gnutls.errors.GNUTLSError(u"error getting peer"
1309
u" certificate")
1837
1310
if list_size.value == 0:
1838
1311
return None
1839
1312
cert = cert_list[0]
1865
1338
if crtverify.value != 0:
1866
1339
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1867
1340
raise (gnutls.errors.CertificateSecurityError
1868
("Verify failed"))
1341
(u"Verify failed"))
1869
1342
# New buffer for the fingerprint
1870
1343
buf = ctypes.create_string_buffer(20)
1871
1344
buf_len = ctypes.c_size_t()
1878
1351
# Convert the buffer to a Python bytestring
1879
1352
fpr = ctypes.string_at(buf, buf_len.value)
1880
1353
# Convert the bytestring to hexadecimal notation
1881
hex_fpr = binascii.hexlify(fpr).upper()
1354
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1882
1355
return hex_fpr
1883
1356
1884
1357
1887
1360
def sub_process_main(self, request, address):
1888
1361
try:
1889
1362
self.finish_request(request, address)
1890
except Exception:
1363
except:
1891
1364
self.handle_error(request, address)
1892
1365
self.close_request(request)
1893
1366
1894
1367
def process_request(self, request, address):
1895
1368
"""Start a new process to process the request."""
1896
proc = multiprocessing.Process(target = self.sub_process_main,
1897
args = (request, address))
1898
proc.start()
1899
return proc
1900
1369
multiprocessing.Process(target = self.sub_process_main,
1370
args = (request, address)).start()
1901
1371
1902
1372
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1903
1373
""" adds a pipe to the MixIn """
1907
1377
This function creates a new pipe in self.pipe
1908
1378
"""
1909
1379
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1910
1911
proc = MultiprocessingMixIn.process_request(self, request,
1912
client_address)
1380
1381
super(MultiprocessingMixInWithPipe,
1382
self).process_request(request, client_address)
1913
1383
self.child_pipe.close()
1914
self.add_pipe(parent_pipe, proc)
1915
1916
def add_pipe(self, parent_pipe, proc):
1384
self.add_pipe(parent_pipe)
1385
1386
def add_pipe(self, parent_pipe):
1917
1387
"""Dummy function; override as necessary"""
1918
raise NotImplementedError
1919
1388
pass
1920
1389
1921
1390
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1922
1391
socketserver.TCPServer, object):
1928
1397
use_ipv6: Boolean; to use IPv6 or not
1929
1398
"""
1930
1399
def __init__(self, server_address, RequestHandlerClass,
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
"""
1400
interface=None, use_ipv6=True):
1935
1401
self.interface = interface
1936
1402
if use_ipv6:
1937
1403
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.
1964
1404
socketserver.TCPServer.__init__(self, server_address,
1965
1405
RequestHandlerClass)
1966
1967
1406
def server_bind(self):
1968
1407
"""This overrides the normal server_bind() function
1969
1408
to bind to an interface if one was specified, and also NOT to
1970
1409
bind to an address or port if they were not specified."""
1971
1410
if self.interface is not None:
1972
1411
if SO_BINDTODEVICE is None:
1973
logger.error("SO_BINDTODEVICE does not exist;"
1974
" cannot bind to interface %s",
1412
logger.error(u"SO_BINDTODEVICE does not exist;"
1413
u" cannot bind to interface %s",
1975
1414
self.interface)
1976
1415
else:
1977
1416
try:
1978
1417
self.socket.setsockopt(socket.SOL_SOCKET,
1979
1418
SO_BINDTODEVICE,
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)
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)
1992
1430
else:
1993
1431
raise
1994
1432
# Only bind(2) the socket if we really need to.
1995
1433
if self.server_address[0] or self.server_address[1]:
1996
1434
if not self.server_address[0]:
1997
1435
if self.address_family == socket.AF_INET6:
1998
any_address = "::" # in6addr_any
1436
any_address = u"::" # in6addr_any
1999
1437
else:
2000
any_address = "0.0.0.0" # INADDR_ANY
1438
any_address = socket.INADDR_ANY
2001
1439
self.server_address = (any_address,
2002
1440
self.server_address[1])
2003
1441
elif not self.server_address[1]:
2024
1462
"""
2025
1463
def __init__(self, server_address, RequestHandlerClass,
2026
1464
interface=None, use_ipv6=True, clients=None,
2027
gnutls_priority=None, use_dbus=True, socketfd=None):
1465
gnutls_priority=None, use_dbus=True):
2028
1466
self.enabled = False
2029
1467
self.clients = clients
2030
1468
if self.clients is None:
2031
self.clients = {}
1469
self.clients = set()
2032
1470
self.use_dbus = use_dbus
2033
1471
self.gnutls_priority = gnutls_priority
2034
1472
IPv6_TCPServer.__init__(self, server_address,
2035
1473
RequestHandlerClass,
2036
1474
interface = interface,
2037
use_ipv6 = use_ipv6,
2038
socketfd = socketfd)
1475
use_ipv6 = use_ipv6)
2039
1476
def server_activate(self):
2040
1477
if self.enabled:
2041
1478
return socketserver.TCPServer.server_activate(self)
2042
2043
1479
def enable(self):
2044
1480
self.enabled = True
2045
2046
def add_pipe(self, parent_pipe, proc):
1481
def add_pipe(self, parent_pipe):
2047
1482
# Call "handle_ipc" for both data and EOF events
2048
1483
gobject.io_add_watch(parent_pipe.fileno(),
2049
1484
gobject.IO_IN | gobject.IO_HUP,
2050
1485
functools.partial(self.handle_ipc,
2051
parent_pipe =
2052
parent_pipe,
2053
proc = proc))
2054
1486
parent_pipe = parent_pipe))
1487
2055
1488
def handle_ipc(self, source, condition, parent_pipe=None,
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()
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):
2061
1506
return False
2062
1507
2063
1508
# Read a request from the child
2068
1513
fpr = request[1]
2069
1514
address = request[2]
2070
1515
2071
for c in self.clients.itervalues():
1516
for c in self.clients:
2072
1517
if c.fingerprint == fpr:
2073
1518
client = c
2074
1519
break
2075
1520
else:
2076
logger.info("Client not found for fingerprint: %s, ad"
2077
"dress: %s", fpr, address)
1521
logger.warning(u"Client not found for fingerprint: %s, ad"
1522
u"dress: %s", fpr, address)
2078
1523
if self.use_dbus:
2079
1524
# Emit D-Bus signal
2080
mandos_dbus_service.ClientNotFound(fpr,
2081
address[0])
1525
mandos_dbus_service.ClientNotFound(fpr, address[0])
2082
1526
parent_pipe.send(False)
2083
1527
return False
2084
1528
2085
1529
gobject.io_add_watch(parent_pipe.fileno(),
2086
1530
gobject.IO_IN | gobject.IO_HUP,
2087
1531
functools.partial(self.handle_ipc,
2088
parent_pipe =
2089
parent_pipe,
2090
proc = proc,
2091
client_object =
2092
client))
1532
parent_pipe = parent_pipe,
1533
client_object = client))
2093
1534
parent_pipe.send(True)
2094
# remove the old hook in favor of the new above hook on
2095
# same fileno
1535
# remove the old hook in favor of the new above hook on same fileno
2096
1536
return False
2097
1537
if command == 'funcall':
2098
1538
funcname = request[1]
2099
1539
args = request[2]
2100
1540
kwargs = request[3]
2101
1541
2102
parent_pipe.send(('data', getattr(client_object,
2103
funcname)(*args,
2104
**kwargs)))
2105
1542
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1543
2106
1544
if command == 'getattr':
2107
1545
attrname = request[1]
2108
1546
if callable(client_object.__getattribute__(attrname)):
2109
1547
parent_pipe.send(('function',))
2110
1548
else:
2111
parent_pipe.send(('data', client_object
2112
.__getattribute__(attrname)))
1549
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2113
1550
2114
1551
if command == 'setattr':
2115
1552
attrname = request[1]
2116
1553
value = request[2]
2117
1554
setattr(client_object, attrname, value)
2118
1555
2119
1556
return True
2120
1557
2121
1558
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
2221
1559
def string_to_delta(interval):
2222
1560
"""Parse a string and return a datetime.timedelta
2223
1561
2224
>>> string_to_delta('7d')
1562
>>> string_to_delta(u'7d')
2225
1563
datetime.timedelta(7)
2226
>>> string_to_delta('60s')
1564
>>> string_to_delta(u'60s')
2227
1565
datetime.timedelta(0, 60)
2228
>>> string_to_delta('60m')
1566
>>> string_to_delta(u'60m')
2229
1567
datetime.timedelta(0, 3600)
2230
>>> string_to_delta('24h')
1568
>>> string_to_delta(u'24h')
2231
1569
datetime.timedelta(1)
2232
>>> string_to_delta('1w')
1570
>>> string_to_delta(u'1w')
2233
1571
datetime.timedelta(7)
2234
>>> string_to_delta('5m 30s')
1572
>>> string_to_delta(u'5m 30s')
2235
1573
datetime.timedelta(0, 330)
2236
1574
"""
2237
2238
try:
2239
return rfc3339_duration_to_delta(interval)
2240
except ValueError:
2241
pass
2242
2243
1575
timevalue = datetime.timedelta(0)
2244
1576
for s in interval.split():
2245
1577
try:
2246
1578
suffix = unicode(s[-1])
2247
1579
value = int(s[:-1])
2248
if suffix == "d":
1580
if suffix == u"d":
2249
1581
delta = datetime.timedelta(value)
2250
elif suffix == "s":
1582
elif suffix == u"s":
2251
1583
delta = datetime.timedelta(0, value)
2252
elif suffix == "m":
1584
elif suffix == u"m":
2253
1585
delta = datetime.timedelta(0, 0, 0, 0, value)
2254
elif suffix == "h":
1586
elif suffix == u"h":
2255
1587
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2256
elif suffix == "w":
1588
elif suffix == u"w":
2257
1589
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2258
1590
else:
2259
raise ValueError("Unknown suffix {0!r}"
2260
.format(suffix))
2261
except (ValueError, IndexError) as e:
2262
raise ValueError(*(e.args))
1591
raise ValueError(u"Unknown suffix %r" % suffix)
1592
except (ValueError, IndexError), e:
1593
raise ValueError(e.message)
2263
1594
timevalue += delta
2264
1595
return timevalue
2265
1596
2266
1597
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
2267
1622
def daemon(nochdir = False, noclose = False):
2268
1623
"""See daemon(3). Standard BSD Unix function.
2269
1624
2272
1627
sys.exit()
2273
1628
os.setsid()
2274
1629
if not nochdir:
2275
os.chdir("/")
1630
os.chdir(u"/")
2276
1631
if os.fork():
2277
1632
sys.exit()
2278
1633
if not noclose:
2279
1634
# Close all standard open file descriptors
2280
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1635
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2281
1636
if not stat.S_ISCHR(os.fstat(null).st_mode):
2282
1637
raise OSError(errno.ENODEV,
2283
"{0} not a character device"
2284
.format(os.devnull))
1638
u"%s not a character device"
1639
% os.path.devnull)
2285
1640
os.dup2(null, sys.stdin.fileno())
2286
1641
os.dup2(null, sys.stdout.fileno())
2287
1642
os.dup2(null, sys.stderr.fileno())
2294
1649
##################################################################
2295
1650
# Parsing of options, both command line and config file
2296
1651
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()
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]
2340
1680
2341
1681
if options.check:
2342
1682
import doctest
2344
1684
sys.exit()
2345
1685
2346
1686
# Default values for config file for server-global settings
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",
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"",
2361
1697
}
2362
1698
2363
1699
# Parse config file for server-global settings
2364
1700
server_config = configparser.SafeConfigParser(server_defaults)
2365
1701
del server_defaults
2366
1702
server_config.read(os.path.join(options.configdir,
2367
"mandos.conf"))
1703
u"mandos.conf"))
2368
1704
# Convert the SafeConfigParser object to a dict
2369
1705
server_settings = server_config.defaults()
2370
1706
# Use the appropriate methods on the non-string config options
2371
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2372
server_settings[option] = server_config.getboolean("DEFAULT",
1707
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1708
server_settings[option] = server_config.getboolean(u"DEFAULT",
2373
1709
option)
2374
1710
if server_settings["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"])
1711
server_settings["port"] = server_config.getint(u"DEFAULT",
1712
u"port")
2386
1713
del server_config
2387
1714
2388
1715
# Override the settings from the config file with command line
2389
1716
# options, if set.
2390
for option in ("interface", "address", "port", "debug",
2391
"priority", "servicename", "configdir",
2392
"use_dbus", "use_ipv6", "debuglevel", "restore",
2393
"statedir", "socket", "foreground"):
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"):
2394
1720
value = getattr(options, option)
2395
1721
if value is not None:
2396
1722
server_settings[option] = value
2399
1725
for option in server_settings.keys():
2400
1726
if type(server_settings[option]) is str:
2401
1727
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
2409
1728
# Now we have our good server settings in "server_settings"
2410
1729
2411
1730
##################################################################
2412
1731
2413
1732
# For convenience
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":
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":
2432
1739
syslogger.setFormatter(logging.Formatter
2433
('Mandos ({0}) [%(process)d]:'
2434
' %(levelname)s: %(message)s'
2435
.format(server_settings
2436
["servicename"])))
1740
(u'Mandos (%s) [%%(process)d]:'
1741
u' %%(levelname)s: %%(message)s'
1742
% server_settings[u"servicename"]))
2437
1743
2438
1744
# Parse config file with clients
2439
client_config = configparser.SafeConfigParser(Client
2440
.client_defaults)
2441
client_config.read(os.path.join(server_settings["configdir"],
2442
"clients.conf"))
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"))
2443
1755
2444
1756
global mandos_dbus_service
2445
1757
mandos_dbus_service = None
2446
1758
2447
tcp_server = MandosServer((server_settings["address"],
2448
server_settings["port"]),
1759
tcp_server = MandosServer((server_settings[u"address"],
1760
server_settings[u"port"]),
2449
1761
ClientHandler,
2450
interface=(server_settings["interface"]
1762
interface=(server_settings[u"interface"]
2451
1763
or None),
2452
1764
use_ipv6=use_ipv6,
2453
1765
gnutls_priority=
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
pidfile = None
1766
server_settings[u"priority"],
1767
use_dbus=use_dbus)
1768
if not debug:
1769
pidfilename = u"/var/run/mandos.pid"
2461
1770
try:
2462
pidfile = open(pidfilename, "w")
2463
except IOError as e:
2464
logger.error("Could not open file %r", pidfilename,
2465
exc_info=e)
1771
pidfile = open(pidfilename, u"w")
1772
except IOError:
1773
logger.error(u"Could not open file %r", pidfilename)
2466
1774
2467
for name in ("_mandos", "mandos", "nobody"):
1775
try:
1776
uid = pwd.getpwnam(u"_mandos").pw_uid
1777
gid = pwd.getpwnam(u"_mandos").pw_gid
1778
except KeyError:
2468
1779
try:
2469
uid = pwd.getpwnam(name).pw_uid
2470
gid = pwd.getpwnam(name).pw_gid
2471
break
1780
uid = pwd.getpwnam(u"mandos").pw_uid
1781
gid = pwd.getpwnam(u"mandos").pw_gid
2472
1782
except KeyError:
2473
continue
2474
else:
2475
uid = 65534
2476
gid = 65534
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
2477
1789
try:
2478
1790
os.setgid(gid)
2479
1791
os.setuid(uid)
2480
except OSError as error:
2481
if error.errno != errno.EPERM:
1792
except OSError, error:
1793
if error[0] != errno.EPERM:
2482
1794
raise error
2483
1795
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
2484
1804
if debug:
2485
1805
# Enable all possible GnuTLS debugging
2486
1806
2490
1810
2491
1811
@gnutls.library.types.gnutls_log_func
2492
1812
def debug_gnutls(level, string):
2493
logger.debug("GnuTLS: %s", string[:-1])
1813
logger.debug(u"GnuTLS: %s", string[:-1])
2494
1814
2495
1815
(gnutls.library.functions
2496
1816
.gnutls_global_set_log_function(debug_gnutls))
2497
1817
2498
1818
# Redirect stdin so all checkers get /dev/null
2499
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1819
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2500
1820
os.dup2(null, sys.stdin.fileno())
2501
1821
if null > 2:
2502
1822
os.close(null)
2503
2504
# Need to fork before connecting to D-Bus
2505
if not foreground:
2506
# Close all input and output, do double fork, etc.
2507
daemon()
2508
2509
# multiprocessing will use threads, so before we use gobject we
2510
# need to inform gobject that threads will be used.
2511
gobject.threads_init()
1823
else:
1824
# No console logging
1825
logger.removeHandler(console)
1826
2512
1827
2513
1828
global main_loop
2514
1829
# From the Avahi example code
2515
DBusGMainLoop(set_as_default=True)
1830
DBusGMainLoop(set_as_default=True )
2516
1831
main_loop = gobject.MainLoop()
2517
1832
bus = dbus.SystemBus()
2518
1833
# End of Avahi example code
2519
1834
if use_dbus:
2520
1835
try:
2521
bus_name = dbus.service.BusName("se.recompile.Mandos",
1836
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2522
1837
bus, do_not_queue=True)
2523
old_bus_name = (dbus.service.BusName
2524
("se.bsnet.fukt.Mandos", bus,
2525
do_not_queue=True))
2526
except dbus.exceptions.NameExistsException as e:
2527
logger.error("Disabling D-Bus:", exc_info=e)
1838
except dbus.exceptions.NameExistsException, e:
1839
logger.error(unicode(e) + u", disabling D-Bus")
2528
1840
use_dbus = False
2529
server_settings["use_dbus"] = False
1841
server_settings[u"use_dbus"] = False
2530
1842
tcp_server.use_dbus = False
2531
1843
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2532
service = AvahiServiceToSyslog(name =
2533
server_settings["servicename"],
2534
servicetype = "_mandos._tcp",
2535
protocol = protocol, bus = bus)
1844
service = AvahiService(name = server_settings[u"servicename"],
1845
servicetype = u"_mandos._tcp",
1846
protocol = protocol, bus = bus)
2536
1847
if server_settings["interface"]:
2537
1848
service.interface = (if_nametoindex
2538
(str(server_settings["interface"])))
2539
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
1855
global multiprocessing_manager
2541
1856
multiprocessing_manager = multiprocessing.Manager()
2542
1857
2543
1858
client_class = Client
2544
1859
if use_dbus:
2545
1860
client_class = functools.partial(ClientDBus, bus = bus)
2546
2547
client_settings = Client.config_parser(client_config)
2548
old_client_settings = {}
2549
clients_data = {}
2550
2551
# This is used to redirect stdout and stderr for checker processes
2552
global wnull
2553
wnull = open(os.devnull, "w") # A writable /dev/null
2554
# Only used if server is running in foreground but not in debug
2555
# mode
2556
if debug or not foreground:
2557
wnull.close()
2558
2559
# Get client data and settings from last running state.
2560
if server_settings["restore"]:
2561
try:
2562
with open(stored_state_path, "rb") as stored_state:
2563
clients_data, old_client_settings = (pickle.load
2564
(stored_state))
2565
os.remove(stored_state_path)
2566
except IOError as e:
2567
if e.errno == errno.ENOENT:
2568
logger.warning("Could not load persistent state: {0}"
2569
.format(os.strerror(e.errno)))
2570
else:
2571
logger.critical("Could not load persistent state:",
2572
exc_info=e)
2573
raise
2574
except EOFError as e:
2575
logger.warning("Could not load persistent state: "
2576
"EOFError:", exc_info=e)
2577
2578
with PGPEngine() as pgp:
2579
for client_name, client in clients_data.iteritems():
2580
# Skip removed clients
2581
if client_name not in client_settings:
2582
continue
2583
2584
# Decide which value to use after restoring saved state.
2585
# We have three different values: Old config file,
2586
# new config file, and saved state.
2587
# New config value takes precedence if it differs from old
2588
# config value, otherwise use saved state.
2589
for name, value in client_settings[client_name].items():
2590
try:
2591
# For each value in new config, check if it
2592
# differs from the old config value (Except for
2593
# the "secret" attribute)
2594
if (name != "secret" and
2595
value != old_client_settings[client_name]
2596
[name]):
2597
client[name] = value
2598
except KeyError:
2599
pass
2600
2601
# Clients who has passed its expire date can still be
2602
# enabled if its last checker was successful. Clients
2603
# whose checker succeeded before we stored its state is
2604
# assumed to have successfully run all checkers during
2605
# downtime.
2606
if client["enabled"]:
2607
if datetime.datetime.utcnow() >= client["expires"]:
2608
if not client["last_checked_ok"]:
2609
logger.warning(
2610
"disabling client {0} - Client never "
2611
"performed a successful checker"
2612
.format(client_name))
2613
client["enabled"] = False
2614
elif client["last_checker_status"] != 0:
2615
logger.warning(
2616
"disabling client {0} - Client "
2617
"last checker failed with error code {1}"
2618
.format(client_name,
2619
client["last_checker_status"]))
2620
client["enabled"] = False
2621
else:
2622
client["expires"] = (datetime.datetime
2623
.utcnow()
2624
+ client["timeout"])
2625
logger.debug("Last checker succeeded,"
2626
" keeping {0} enabled"
2627
.format(client_name))
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):
2628
1868
try:
2629
client["secret"] = (
2630
pgp.decrypt(client["encrypted_secret"],
2631
client_settings[client_name]
2632
["secret"]))
2633
except PGPError:
2634
# If decryption fails, we use secret from new settings
2635
logger.debug("Failed to decrypt {0} old secret"
2636
.format(client_name))
2637
client["secret"] = (
2638
client_settings[client_name]["secret"])
2639
2640
# Add/remove clients based on new changes made to config
2641
for client_name in (set(old_client_settings)
2642
- set(client_settings)):
2643
del clients_data[client_name]
2644
for client_name in (set(client_settings)
2645
- set(old_client_settings)):
2646
clients_data[client_name] = client_settings[client_name]
2647
2648
# Create all client objects
2649
for client_name, client in clients_data.iteritems():
2650
tcp_server.clients[client_name] = client_class(
2651
name = client_name, settings = client,
2652
server_settings = server_settings)
2653
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()))
2654
1878
if not tcp_server.clients:
2655
logger.warning("No clients defined")
2656
2657
if not foreground:
2658
if pidfile is not None:
2659
try:
2660
with pidfile:
2661
pid = os.getpid()
2662
pidfile.write(str(pid) + "\n".encode("utf-8"))
2663
except IOError:
2664
logger.error("Could not write to file %r with PID %d",
2665
pidfilename, pid)
2666
del pidfile
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
2667
1893
del pidfilename
2668
1894
1895
signal.signal(signal.SIGINT, signal.SIG_IGN)
1896
2669
1897
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2670
1898
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2671
1899
2672
1900
if use_dbus:
2673
@alternate_dbus_interfaces({"se.recompile.Mandos":
2674
"se.bsnet.fukt.Mandos"})
2675
class MandosDBusService(DBusObjectWithProperties):
1901
class MandosDBusService(dbus.service.Object):
2676
1902
"""A D-Bus proxy object"""
2677
1903
def __init__(self):
2678
dbus.service.Object.__init__(self, bus, "/")
2679
_interface = "se.recompile.Mandos"
2680
2681
@dbus_interface_annotations(_interface)
2682
def _foo(self):
2683
return { "org.freedesktop.DBus.Property"
2684
".EmitsChangedSignal":
2685
"false"}
2686
2687
@dbus.service.signal(_interface, signature="o")
1904
dbus.service.Object.__init__(self, bus, u"/")
1905
_interface = u"se.bsnet.fukt.Mandos"
1906
1907
@dbus.service.signal(_interface, signature=u"o")
2688
1908
def ClientAdded(self, objpath):
2689
1909
"D-Bus signal"
2690
1910
pass
2691
1911
2692
@dbus.service.signal(_interface, signature="ss")
1912
@dbus.service.signal(_interface, signature=u"ss")
2693
1913
def ClientNotFound(self, fingerprint, address):
2694
1914
"D-Bus signal"
2695
1915
pass
2696
1916
2697
@dbus.service.signal(_interface, signature="os")
1917
@dbus.service.signal(_interface, signature=u"os")
2698
1918
def ClientRemoved(self, objpath, name):
2699
1919
"D-Bus signal"
2700
1920
pass
2701
1921
2702
@dbus.service.method(_interface, out_signature="ao")
1922
@dbus.service.method(_interface, out_signature=u"ao")
2703
1923
def GetAllClients(self):
2704
1924
"D-Bus method"
2705
1925
return dbus.Array(c.dbus_object_path
2706
for c in
2707
tcp_server.clients.itervalues())
1926
for c in tcp_server.clients)
2708
1927
2709
1928
@dbus.service.method(_interface,
2710
out_signature="a{oa{sv}}")
1929
out_signature=u"a{oa{sv}}")
2711
1930
def GetAllClientsWithProperties(self):
2712
1931
"D-Bus method"
2713
1932
return dbus.Dictionary(
2714
((c.dbus_object_path, c.GetAll(""))
2715
for c in tcp_server.clients.itervalues()),
2716
signature="oa{sv}")
1933
((c.dbus_object_path, c.GetAll(u""))
1934
for c in tcp_server.clients),
1935
signature=u"oa{sv}")
2717
1936
2718
@dbus.service.method(_interface, in_signature="o")
1937
@dbus.service.method(_interface, in_signature=u"o")
2719
1938
def RemoveClient(self, object_path):
2720
1939
"D-Bus method"
2721
for c in tcp_server.clients.itervalues():
1940
for c in tcp_server.clients:
2722
1941
if c.dbus_object_path == object_path:
2723
del tcp_server.clients[c.name]
1942
tcp_server.clients.remove(c)
2724
1943
c.remove_from_connection()
2725
1944
# Don't signal anything except ClientRemoved
2726
1945
c.disable(quiet=True)
2737
1956
"Cleanup function; run on exit"
2738
1957
service.cleanup()
2739
1958
2740
multiprocessing.active_children()
2741
wnull.close()
2742
if not (tcp_server.clients or client_settings):
2743
return
2744
2745
# Store client before exiting. Secrets are encrypted with key
2746
# based on what config file has. If config file is
2747
# removed/edited, old secret will thus be unrecovable.
2748
clients = {}
2749
with PGPEngine() as pgp:
2750
for client in tcp_server.clients.itervalues():
2751
key = client_settings[client.name]["secret"]
2752
client.encrypted_secret = pgp.encrypt(client.secret,
2753
key)
2754
client_dict = {}
2755
2756
# A list of attributes that can not be pickled
2757
# + secret.
2758
exclude = set(("bus", "changedstate", "secret",
2759
"checker", "server_settings"))
2760
for name, typ in (inspect.getmembers
2761
(dbus.service.Object)):
2762
exclude.add(name)
2763
2764
client_dict["encrypted_secret"] = (client
2765
.encrypted_secret)
2766
for attr in client.client_structure:
2767
if attr not in exclude:
2768
client_dict[attr] = getattr(client, attr)
2769
2770
clients[client.name] = client_dict
2771
del client_settings[client.name]["secret"]
2772
2773
try:
2774
with (tempfile.NamedTemporaryFile
2775
(mode='wb', suffix=".pickle", prefix='clients-',
2776
dir=os.path.dirname(stored_state_path),
2777
delete=False)) as stored_state:
2778
pickle.dump((clients, client_settings), stored_state)
2779
tempname=stored_state.name
2780
os.rename(tempname, stored_state_path)
2781
except (IOError, OSError) as e:
2782
if not debug:
2783
try:
2784
os.remove(tempname)
2785
except NameError:
2786
pass
2787
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2788
logger.warning("Could not save persistent state: {0}"
2789
.format(os.strerror(e.errno)))
2790
else:
2791
logger.warning("Could not save persistent state:",
2792
exc_info=e)
2793
raise e
2794
2795
# Delete all clients, and settings from config
2796
1959
while tcp_server.clients:
2797
name, client = tcp_server.clients.popitem()
1960
client = tcp_server.clients.pop()
2798
1961
if use_dbus:
2799
1962
client.remove_from_connection()
1963
client.disable_hook = None
2800
1964
# Don't signal anything except ClientRemoved
2801
1965
client.disable(quiet=True)
2802
1966
if use_dbus:
2803
1967
# Emit D-Bus signal
2804
mandos_dbus_service.ClientRemoved(client
2805
.dbus_object_path,
1968
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2806
1969
client.name)
2807
client_settings.clear()
2808
1970
2809
1971
atexit.register(cleanup)
2810
1972
2811
for client in tcp_server.clients.itervalues():
1973
for client in tcp_server.clients:
2812
1974
if use_dbus:
2813
1975
# Emit D-Bus signal
2814
1976
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2815
# Need to initiate checking of clients
2816
if client.enabled:
2817
client.init_checker()
1977
client.enable()
2818
1978
2819
1979
tcp_server.enable()
2820
1980
tcp_server.server_activate()
2822
1982
# Find out what port we got
2823
1983
service.port = tcp_server.socket.getsockname()[1]
2824
1984
if use_ipv6:
2825
logger.info("Now listening on address %r, port %d,"
2826
" flowinfo %d, scope_id %d",
2827
*tcp_server.socket.getsockname())
1985
logger.info(u"Now listening on address %r, port %d,"
1986
" flowinfo %d, scope_id %d"
1987
% tcp_server.socket.getsockname())
2828
1988
else: # IPv4
2829
logger.info("Now listening on address %r, port %d",
2830
*tcp_server.socket.getsockname())
1989
logger.info(u"Now listening on address %r, port %d"
1990
% tcp_server.socket.getsockname())
2831
1991
2832
1992
#service.interface = tcp_server.socket.getsockname()[3]
2833
1993
2835
1995
# From the Avahi example code
2836
1996
try:
2837
1997
service.activate()
2838
except dbus.exceptions.DBusException as error:
2839
logger.critical("D-Bus Exception", exc_info=error)
1998
except dbus.exceptions.DBusException, error:
1999
logger.critical(u"DBusException: %s", error)
2840
2000
cleanup()
2841
2001
sys.exit(1)
2842
2002
# End of Avahi example code
2846
2006
(tcp_server.handle_request
2847
2007
(*args[2:], **kwargs) or True))
2848
2008
2849
logger.debug("Starting main loop")
2009
logger.debug(u"Starting main loop")
2850
2010
main_loop.run()
2851
except AvahiError as error:
2852
logger.critical("Avahi Error", exc_info=error)
2011
except AvahiError, error:
2012
logger.critical(u"AvahiError: %s", error)
2853
2013
cleanup()
2854
2014
sys.exit(1)
2855
2015
except KeyboardInterrupt:
2856
2016
if debug:
2857
print("", file=sys.stderr)
2858
logger.debug("Server received KeyboardInterrupt")
2859
logger.debug("Server exiting")
2017
print >> sys.stderr
2018
logger.debug(u"Server received KeyboardInterrupt")
2019
logger.debug(u"Server exiting")
2860
2020
# Must run before the D-Bus bus name gets deregistered
2861
2021
cleanup()
2862
2022
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0