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