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.1
- compare with another revision
- download diff
- download tarball
- view history from revision 24.2.1
- Committer: teddy at bsnet
- Date: 2010-08-23 19:23:15 UTC
- mto: (24.1.154 mandos)
- mto: This revision was merged to the branch mainline in revision 421.
- Revision ID: teddy@fukt.bsnet.se-20100823192315-pefgye0l6cavcejs
* debian/control (mandos/Depends): Added "python-urwid".
* mandos (Client.approved_by_default): Changed default to "True".
(Client.approved_delay): Changed default to "0s".
(ClientDBus.GotSecret, ClientDBus.Rejected,
ClientDBus.NeedApproval): Emit "PropertyChanged" signal for the
"approved_pending" property.
* mandos (Client.approved_by_default): Changed default to "True".
(Client.approved_delay): Changed default to "0s".
(ClientDBus.GotSecret, ClientDBus.Rejected,
ClientDBus.NeedApproval): Emit "PropertyChanged" signal for the
"approved_pending" property.
- 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-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 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.3"
92
stored_state_file = "clients.pickle"
93
94
logger = logging.getLogger()
83
84
version = "1.0.14"
85
86
logger = logging.Logger(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)
579
580
# Send notice to process children that client state has changed
327
self._approved = None
328
self.approved_by_default = config.get(u"approved_by_default",
329
True)
330
self.approved_delay = string_to_delta(
331
config[u"approved_delay"])
332
self.approved_duration = string_to_delta(
333
config[u"approved_duration"])
334
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
335
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":
937
raise ValueError("Byte arrays not supported for non-"
938
"'ay' signature {0!r}"
939
.format(prop._dbus_signature))
940
value = dbus.ByteArray(b''.join(chr(byte)
941
for byte in value))
616
if prop._dbus_signature != u"ay":
617
raise ValueError
618
value = dbus.ByteArray(''.join(unichr(byte)
619
for byte in value))
942
620
prop(value)
943
621
944
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
945
out_signature="a{sv}")
622
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
623
out_signature=u"a{sv}")
946
624
def GetAll(self, interface_name):
947
625
"""Standard D-Bus property GetAll() method, see D-Bus
948
626
standard.
949
627
950
628
Note: Will not include properties with access="write".
951
629
"""
952
properties = {}
953
for name, prop in self._get_all_dbus_things("property"):
630
all = {}
631
for name, prop in self._get_all_dbus_properties():
954
632
if (interface_name
955
633
and interface_name != prop._dbus_interface):
956
634
# Interface non-empty but did not match
957
635
continue
958
636
# Ignore write-only properties
959
if prop._dbus_access == "write":
637
if prop._dbus_access == u"write":
960
638
continue
961
639
value = prop()
962
if not hasattr(value, "variant_level"):
963
properties[name] = value
640
if not hasattr(value, u"variant_level"):
641
all[name] = value
964
642
continue
965
properties[name] = type(value)(value, variant_level=
966
value.variant_level+1)
967
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")
968
646
969
647
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
970
out_signature="s",
648
out_signature=u"s",
971
649
path_keyword='object_path',
972
650
connection_keyword='connection')
973
651
def Introspect(self, object_path, connection):
974
"""Overloading of standard D-Bus method.
975
976
Inserts property tags and interface annotation tags.
652
"""Standard D-Bus method, overloaded to insert property tags.
977
653
"""
978
654
xmlstring = dbus.service.Object.Introspect(self, object_path,
979
655
connection)
980
656
try:
981
657
document = xml.dom.minidom.parseString(xmlstring)
982
658
def make_tag(document, name, prop):
983
e = document.createElement("property")
984
e.setAttribute("name", name)
985
e.setAttribute("type", prop._dbus_signature)
986
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)
987
663
return e
988
for if_tag in document.getElementsByTagName("interface"):
989
# Add property tags
664
for if_tag in document.getElementsByTagName(u"interface"):
990
665
for tag in (make_tag(document, name, prop)
991
666
for name, prop
992
in self._get_all_dbus_things("property")
667
in self._get_all_dbus_properties()
993
668
if prop._dbus_interface
994
== if_tag.getAttribute("name")):
669
== if_tag.getAttribute(u"name")):
995
670
if_tag.appendChild(tag)
996
# Add annotation tags
997
for typ in ("method", "signal", "property"):
998
for tag in if_tag.getElementsByTagName(typ):
999
annots = dict()
1000
for name, prop in (self.
1001
_get_all_dbus_things(typ)):
1002
if (name == tag.getAttribute("name")
1003
and prop._dbus_interface
1004
== if_tag.getAttribute("name")):
1005
annots.update(getattr
1006
(prop,
1007
"_dbus_annotations",
1008
{}))
1009
for name, value in annots.iteritems():
1010
ann_tag = document.createElement(
1011
"annotation")
1012
ann_tag.setAttribute("name", name)
1013
ann_tag.setAttribute("value", value)
1014
tag.appendChild(ann_tag)
1015
# Add interface annotation tags
1016
for annotation, value in dict(
1017
itertools.chain.from_iterable(
1018
annotations().iteritems()
1019
for name, annotations in
1020
self._get_all_dbus_things("interface")
1021
if name == if_tag.getAttribute("name")
1022
)).iteritems():
1023
ann_tag = document.createElement("annotation")
1024
ann_tag.setAttribute("name", annotation)
1025
ann_tag.setAttribute("value", value)
1026
if_tag.appendChild(ann_tag)
1027
671
# Add the names to the return values for the
1028
672
# "org.freedesktop.DBus.Properties" methods
1029
if (if_tag.getAttribute("name")
1030
== "org.freedesktop.DBus.Properties"):
1031
for cn in if_tag.getElementsByTagName("method"):
1032
if cn.getAttribute("name") == "Get":
1033
for arg in cn.getElementsByTagName("arg"):
1034
if (arg.getAttribute("direction")
1035
== "out"):
1036
arg.setAttribute("name", "value")
1037
elif cn.getAttribute("name") == "GetAll":
1038
for arg in cn.getElementsByTagName("arg"):
1039
if (arg.getAttribute("direction")
1040
== "out"):
1041
arg.setAttribute("name", "props")
1042
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")
1043
687
document.unlink()
1044
688
except (AttributeError, xml.dom.DOMException,
1045
xml.parsers.expat.ExpatError) as error:
1046
logger.error("Failed to override Introspection method",
1047
exc_info=error)
689
xml.parsers.expat.ExpatError), error:
690
logger.error(u"Failed to override Introspection method",
691
error)
1048
692
return xmlstring
1049
693
1050
694
1051
def datetime_to_dbus(dt, variant_level=0):
1052
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1053
if dt is None:
1054
return dbus.String("", variant_level = variant_level)
1055
return dbus.String(dt.isoformat(),
1056
variant_level=variant_level)
1057
1058
1059
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1060
"""A class decorator; applied to a subclass of
1061
dbus.service.Object, it will add alternate D-Bus attributes with
1062
interface names according to the "alt_interface_names" mapping.
1063
Usage:
1064
1065
@alternate_dbus_interfaces({"org.example.Interface":
1066
"net.example.AlternateInterface"})
1067
class SampleDBusObject(dbus.service.Object):
1068
@dbus.service.method("org.example.Interface")
1069
def SampleDBusMethod():
1070
pass
1071
1072
The above "SampleDBusMethod" on "SampleDBusObject" will be
1073
reachable via two interfaces: "org.example.Interface" and
1074
"net.example.AlternateInterface", the latter of which will have
1075
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1076
"true", unless "deprecate" is passed with a False value.
1077
1078
This works for methods and signals, and also for D-Bus properties
1079
(from DBusObjectWithProperties) and interfaces (from the
1080
dbus_interface_annotations decorator).
1081
"""
1082
def wrapper(cls):
1083
for orig_interface_name, alt_interface_name in (
1084
alt_interface_names.iteritems()):
1085
attr = {}
1086
interface_names = set()
1087
# Go though all attributes of the class
1088
for attrname, attribute in inspect.getmembers(cls):
1089
# Ignore non-D-Bus attributes, and D-Bus attributes
1090
# with the wrong interface name
1091
if (not hasattr(attribute, "_dbus_interface")
1092
or not attribute._dbus_interface
1093
.startswith(orig_interface_name)):
1094
continue
1095
# Create an alternate D-Bus interface name based on
1096
# the current name
1097
alt_interface = (attribute._dbus_interface
1098
.replace(orig_interface_name,
1099
alt_interface_name))
1100
interface_names.add(alt_interface)
1101
# Is this a D-Bus signal?
1102
if getattr(attribute, "_dbus_is_signal", False):
1103
# Extract the original non-method undecorated
1104
# function by black magic
1105
nonmethod_func = (dict(
1106
zip(attribute.func_code.co_freevars,
1107
attribute.__closure__))["func"]
1108
.cell_contents)
1109
# Create a new, but exactly alike, function
1110
# object, and decorate it to be a new D-Bus signal
1111
# with the alternate D-Bus interface name
1112
new_function = (dbus.service.signal
1113
(alt_interface,
1114
attribute._dbus_signature)
1115
(types.FunctionType(
1116
nonmethod_func.func_code,
1117
nonmethod_func.func_globals,
1118
nonmethod_func.func_name,
1119
nonmethod_func.func_defaults,
1120
nonmethod_func.func_closure)))
1121
# Copy annotations, if any
1122
try:
1123
new_function._dbus_annotations = (
1124
dict(attribute._dbus_annotations))
1125
except AttributeError:
1126
pass
1127
# Define a creator of a function to call both the
1128
# original and alternate functions, so both the
1129
# original and alternate signals gets sent when
1130
# the function is called
1131
def fixscope(func1, func2):
1132
"""This function is a scope container to pass
1133
func1 and func2 to the "call_both" function
1134
outside of its arguments"""
1135
def call_both(*args, **kwargs):
1136
"""This function will emit two D-Bus
1137
signals by calling func1 and func2"""
1138
func1(*args, **kwargs)
1139
func2(*args, **kwargs)
1140
return call_both
1141
# Create the "call_both" function and add it to
1142
# the class
1143
attr[attrname] = fixscope(attribute, new_function)
1144
# Is this a D-Bus method?
1145
elif getattr(attribute, "_dbus_is_method", False):
1146
# Create a new, but exactly alike, function
1147
# object. Decorate it to be a new D-Bus method
1148
# with the alternate D-Bus interface name. Add it
1149
# to the class.
1150
attr[attrname] = (dbus.service.method
1151
(alt_interface,
1152
attribute._dbus_in_signature,
1153
attribute._dbus_out_signature)
1154
(types.FunctionType
1155
(attribute.func_code,
1156
attribute.func_globals,
1157
attribute.func_name,
1158
attribute.func_defaults,
1159
attribute.func_closure)))
1160
# Copy annotations, if any
1161
try:
1162
attr[attrname]._dbus_annotations = (
1163
dict(attribute._dbus_annotations))
1164
except AttributeError:
1165
pass
1166
# Is this a D-Bus property?
1167
elif getattr(attribute, "_dbus_is_property", False):
1168
# Create a new, but exactly alike, function
1169
# object, and decorate it to be a new D-Bus
1170
# property with the alternate D-Bus interface
1171
# name. Add it to the class.
1172
attr[attrname] = (dbus_service_property
1173
(alt_interface,
1174
attribute._dbus_signature,
1175
attribute._dbus_access,
1176
attribute
1177
._dbus_get_args_options
1178
["byte_arrays"])
1179
(types.FunctionType
1180
(attribute.func_code,
1181
attribute.func_globals,
1182
attribute.func_name,
1183
attribute.func_defaults,
1184
attribute.func_closure)))
1185
# Copy annotations, if any
1186
try:
1187
attr[attrname]._dbus_annotations = (
1188
dict(attribute._dbus_annotations))
1189
except AttributeError:
1190
pass
1191
# Is this a D-Bus interface?
1192
elif getattr(attribute, "_dbus_is_interface", False):
1193
# Create a new, but exactly alike, function
1194
# object. Decorate it to be a new D-Bus interface
1195
# with the alternate D-Bus interface name. Add it
1196
# to the class.
1197
attr[attrname] = (dbus_interface_annotations
1198
(alt_interface)
1199
(types.FunctionType
1200
(attribute.func_code,
1201
attribute.func_globals,
1202
attribute.func_name,
1203
attribute.func_defaults,
1204
attribute.func_closure)))
1205
if deprecate:
1206
# Deprecate all alternate interfaces
1207
iname="_AlternateDBusNames_interface_annotation{0}"
1208
for interface_name in interface_names:
1209
@dbus_interface_annotations(interface_name)
1210
def func(self):
1211
return { "org.freedesktop.DBus.Deprecated":
1212
"true" }
1213
# Find an unused name
1214
for aname in (iname.format(i)
1215
for i in itertools.count()):
1216
if aname not in attr:
1217
attr[aname] = func
1218
break
1219
if interface_names:
1220
# Replace the class with a new subclass of it with
1221
# methods, signals, etc. as created above.
1222
cls = type(b"{0}Alternate".format(cls.__name__),
1223
(cls,), attr)
1224
return cls
1225
return wrapper
1226
1227
1228
@alternate_dbus_interfaces({"se.recompile.Mandos":
1229
"se.bsnet.fukt.Mandos"})
1230
695
class ClientDBus(Client, DBusObjectWithProperties):
1231
696
"""A Client class using D-Bus
1232
697
1234
699
dbus_object_path: dbus.ObjectPath
1235
700
bus: dbus.SystemBus()
1236
701
"""
1237
1238
runtime_expansions = (Client.runtime_expansions
1239
+ ("dbus_object_path",))
1240
1241
702
# dbus.service.Object doesn't use super(), so we can't either.
1242
703
1243
704
def __init__(self, bus = None, *args, **kwargs):
1245
706
Client.__init__(self, *args, **kwargs)
1246
707
# Only now, when this client is initialized, can it show up on
1247
708
# the D-Bus
1248
client_object_name = unicode(self.name).translate(
1249
{ord("."): ord("_"),
1250
ord("-"): ord("_")})
1251
709
self.dbus_object_path = (dbus.ObjectPath
1252
("/clients/" + client_object_name))
710
(u"/clients/"
711
+ self.name.replace(u".", u"_")))
1253
712
DBusObjectWithProperties.__init__(self, self.bus,
1254
713
self.dbus_object_path)
1255
714
1256
def notifychangeproperty(transform_func,
1257
dbus_name, type_func=lambda x: x,
1258
variant_level=1):
1259
""" Modify a variable so that it's a property which announces
1260
its changes to DBus.
1261
1262
transform_fun: Function that takes a value and a variant_level
1263
and transforms it to a D-Bus type.
1264
dbus_name: D-Bus name of the variable
1265
type_func: Function that transform the value before sending it
1266
to the D-Bus. Default: no transform
1267
variant_level: D-Bus variant level. Default: 1
1268
"""
1269
attrname = "_{0}".format(dbus_name)
1270
def setter(self, value):
1271
if hasattr(self, "dbus_object_path"):
1272
if (not hasattr(self, attrname) or
1273
type_func(getattr(self, attrname, None))
1274
!= type_func(value)):
1275
dbus_value = transform_func(type_func(value),
1276
variant_level
1277
=variant_level)
1278
self.PropertyChanged(dbus.String(dbus_name),
1279
dbus_value)
1280
setattr(self, attrname, value)
1281
1282
return property(lambda self: getattr(self, attrname), setter)
1283
1284
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1285
approvals_pending = notifychangeproperty(dbus.Boolean,
1286
"ApprovalPending",
1287
type_func = bool)
1288
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1289
last_enabled = notifychangeproperty(datetime_to_dbus,
1290
"LastEnabled")
1291
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1292
type_func = lambda checker:
1293
checker is not None)
1294
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1295
"LastCheckedOK")
1296
last_checker_status = notifychangeproperty(dbus.Int16,
1297
"LastCheckerStatus")
1298
last_approval_request = notifychangeproperty(
1299
datetime_to_dbus, "LastApprovalRequest")
1300
approved_by_default = notifychangeproperty(dbus.Boolean,
1301
"ApprovedByDefault")
1302
approval_delay = notifychangeproperty(dbus.UInt64,
1303
"ApprovalDelay",
1304
type_func =
1305
timedelta_to_milliseconds)
1306
approval_duration = notifychangeproperty(
1307
dbus.UInt64, "ApprovalDuration",
1308
type_func = timedelta_to_milliseconds)
1309
host = notifychangeproperty(dbus.String, "Host")
1310
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1311
type_func =
1312
timedelta_to_milliseconds)
1313
extended_timeout = notifychangeproperty(
1314
dbus.UInt64, "ExtendedTimeout",
1315
type_func = timedelta_to_milliseconds)
1316
interval = notifychangeproperty(dbus.UInt64,
1317
"Interval",
1318
type_func =
1319
timedelta_to_milliseconds)
1320
checker_command = notifychangeproperty(dbus.String, "Checker")
1321
1322
del notifychangeproperty
715
@staticmethod
716
def _datetime_to_dbus(dt, variant_level=0):
717
"""Convert a UTC datetime.datetime() to a D-Bus type."""
718
return dbus.String(dt.isoformat(),
719
variant_level=variant_level)
720
721
def enable(self):
722
oldstate = getattr(self, u"enabled", False)
723
r = Client.enable(self)
724
if oldstate != self.enabled:
725
# Emit D-Bus signals
726
self.PropertyChanged(dbus.String(u"enabled"),
727
dbus.Boolean(True, variant_level=1))
728
self.PropertyChanged(
729
dbus.String(u"last_enabled"),
730
self._datetime_to_dbus(self.last_enabled,
731
variant_level=1))
732
return r
733
734
def disable(self, quiet = False):
735
oldstate = getattr(self, u"enabled", False)
736
r = Client.disable(self, quiet=quiet)
737
if not quiet and oldstate != self.enabled:
738
# Emit D-Bus signal
739
self.PropertyChanged(dbus.String(u"enabled"),
740
dbus.Boolean(False, variant_level=1))
741
return r
1323
742
1324
743
def __del__(self, *args, **kwargs):
1325
744
try:
1326
745
self.remove_from_connection()
1327
746
except LookupError:
1328
747
pass
1329
if hasattr(DBusObjectWithProperties, "__del__"):
748
if hasattr(DBusObjectWithProperties, u"__del__"):
1330
749
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1331
750
Client.__del__(self, *args, **kwargs)
1332
751
1334
753
*args, **kwargs):
1335
754
self.checker_callback_tag = None
1336
755
self.checker = None
756
# Emit D-Bus signal
757
self.PropertyChanged(dbus.String(u"checker_running"),
758
dbus.Boolean(False, variant_level=1))
1337
759
if os.WIFEXITED(condition):
1338
760
exitstatus = os.WEXITSTATUS(condition)
1339
761
# Emit D-Bus signal
1349
771
return Client.checker_callback(self, pid, condition, command,
1350
772
*args, **kwargs)
1351
773
774
def checked_ok(self, *args, **kwargs):
775
r = Client.checked_ok(self, *args, **kwargs)
776
# Emit D-Bus signal
777
self.PropertyChanged(
778
dbus.String(u"last_checked_ok"),
779
(self._datetime_to_dbus(self.last_checked_ok,
780
variant_level=1)))
781
return r
782
1352
783
def start_checker(self, *args, **kwargs):
1353
784
old_checker = self.checker
1354
785
if self.checker is not None:
1361
792
and old_checker_pid != self.checker.pid):
1362
793
# Emit D-Bus signal
1363
794
self.CheckerStarted(self.current_checker_command)
795
self.PropertyChanged(
796
dbus.String(u"checker_running"),
797
dbus.Boolean(True, variant_level=1))
1364
798
return r
1365
799
800
def stop_checker(self, *args, **kwargs):
801
old_checker = getattr(self, u"checker", None)
802
r = Client.stop_checker(self, *args, **kwargs)
803
if (old_checker is not None
804
and getattr(self, u"checker", None) is None):
805
self.PropertyChanged(dbus.String(u"checker_running"),
806
dbus.Boolean(False, variant_level=1))
807
return r
808
1366
809
def _reset_approved(self):
1367
self.approved = None
810
self._approved = None
1368
811
return False
1369
812
1370
813
def approve(self, value=True):
1371
self.approved = value
1372
gobject.timeout_add(timedelta_to_milliseconds
1373
(self.approval_duration),
1374
self._reset_approved)
1375
self.send_changedstate()
814
self._approved = value
815
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
816
817
def approved_pending(self):
818
return self.approvals_pending > 0
819
1376
820
1377
821
## D-Bus methods, signals & properties
1378
_interface = "se.recompile.Mandos.Client"
1379
1380
## Interfaces
1381
1382
@dbus_interface_annotations(_interface)
1383
def _foo(self):
1384
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1385
"false"}
822
_interface = u"se.bsnet.fukt.Mandos.Client"
1386
823
1387
824
## Signals
1388
825
1389
826
# CheckerCompleted - signal
1390
@dbus.service.signal(_interface, signature="nxs")
827
@dbus.service.signal(_interface, signature=u"nxs")
1391
828
def CheckerCompleted(self, exitcode, waitstatus, command):
1392
829
"D-Bus signal"
1393
830
pass
1394
831
1395
832
# CheckerStarted - signal
1396
@dbus.service.signal(_interface, signature="s")
833
@dbus.service.signal(_interface, signature=u"s")
1397
834
def CheckerStarted(self, command):
1398
835
"D-Bus signal"
1399
836
pass
1400
837
1401
838
# PropertyChanged - signal
1402
@dbus.service.signal(_interface, signature="sv")
839
@dbus.service.signal(_interface, signature=u"sv")
1403
840
def PropertyChanged(self, property, value):
1404
841
"D-Bus signal"
1405
842
pass
1407
844
# GotSecret - signal
1408
845
@dbus.service.signal(_interface)
1409
846
def GotSecret(self):
1410
"""D-Bus signal
1411
Is sent after a successful transfer of secret from the Mandos
1412
server to mandos-client
1413
"""
1414
pass
847
"D-Bus signal"
848
if self.approved_pending():
849
self.PropertyChanged(dbus.String(u"checker_running"),
850
dbus.Boolean(False, variant_level=1))
1415
851
1416
852
# Rejected - signal
1417
@dbus.service.signal(_interface, signature="s")
853
@dbus.service.signal(_interface, signature=u"s")
1418
854
def Rejected(self, reason):
1419
855
"D-Bus signal"
1420
pass
856
if self.approved_pending():
857
self.PropertyChanged(dbus.String(u"checker_running"),
858
dbus.Boolean(False, variant_level=1))
1421
859
1422
860
# NeedApproval - signal
1423
@dbus.service.signal(_interface, signature="tb")
861
@dbus.service.signal(_interface, signature=u"db")
1424
862
def NeedApproval(self, timeout, default):
1425
863
"D-Bus signal"
1426
return self.need_approval()
864
if not self.approved_pending():
865
self.PropertyChanged(dbus.String(u"approved_pending"),
866
dbus.Boolean(True, variant_level=1))
1427
867
1428
868
## Methods
1429
869
1430
870
# Approve - method
1431
@dbus.service.method(_interface, in_signature="b")
871
@dbus.service.method(_interface, in_signature=u"b")
1432
872
def Approve(self, value):
1433
873
self.approve(value)
1434
874
1435
875
# CheckedOK - method
1436
876
@dbus.service.method(_interface)
1437
877
def CheckedOK(self):
1438
self.checked_ok()
878
return self.checked_ok()
1439
879
1440
880
# Enable - method
1441
881
@dbus.service.method(_interface)
1462
902
1463
903
## Properties
1464
904
1465
# ApprovalPending - property
1466
@dbus_service_property(_interface, signature="b", access="read")
1467
def ApprovalPending_dbus_property(self):
1468
return dbus.Boolean(bool(self.approvals_pending))
1469
1470
# ApprovedByDefault - property
1471
@dbus_service_property(_interface, signature="b",
1472
access="readwrite")
1473
def ApprovedByDefault_dbus_property(self, value=None):
1474
if value is None: # get
1475
return dbus.Boolean(self.approved_by_default)
1476
self.approved_by_default = bool(value)
1477
1478
# ApprovalDelay - property
1479
@dbus_service_property(_interface, signature="t",
1480
access="readwrite")
1481
def ApprovalDelay_dbus_property(self, value=None):
1482
if value is None: # get
1483
return dbus.UInt64(self.approval_delay_milliseconds())
1484
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1485
1486
# ApprovalDuration - property
1487
@dbus_service_property(_interface, signature="t",
1488
access="readwrite")
1489
def ApprovalDuration_dbus_property(self, value=None):
1490
if value is None: # get
1491
return dbus.UInt64(timedelta_to_milliseconds(
1492
self.approval_duration))
1493
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1494
1495
# Name - property
1496
@dbus_service_property(_interface, signature="s", access="read")
1497
def Name_dbus_property(self):
905
# approved_pending - property
906
@dbus_service_property(_interface, signature=u"b", access=u"read")
907
def approved_pending_dbus_property(self):
908
return dbus.Boolean(self.approved_pending())
909
910
# approved_by_default - property
911
@dbus_service_property(_interface, signature=u"b",
912
access=u"readwrite")
913
def approved_by_default_dbus_property(self):
914
return dbus.Boolean(self.approved_by_default)
915
916
# approved_delay - property
917
@dbus_service_property(_interface, signature=u"t",
918
access=u"readwrite")
919
def approved_delay_dbus_property(self):
920
return dbus.UInt64(self.approved_delay_milliseconds())
921
922
# approved_duration - property
923
@dbus_service_property(_interface, signature=u"t",
924
access=u"readwrite")
925
def approved_duration_dbus_property(self):
926
return dbus.UInt64(self._timedelta_to_milliseconds(
927
self.approved_duration))
928
929
# name - property
930
@dbus_service_property(_interface, signature=u"s", access=u"read")
931
def name_dbus_property(self):
1498
932
return dbus.String(self.name)
1499
933
1500
# Fingerprint - property
1501
@dbus_service_property(_interface, signature="s", access="read")
1502
def Fingerprint_dbus_property(self):
934
# fingerprint - property
935
@dbus_service_property(_interface, signature=u"s", access=u"read")
936
def fingerprint_dbus_property(self):
1503
937
return dbus.String(self.fingerprint)
1504
938
1505
# Host - property
1506
@dbus_service_property(_interface, signature="s",
1507
access="readwrite")
1508
def Host_dbus_property(self, value=None):
939
# host - property
940
@dbus_service_property(_interface, signature=u"s",
941
access=u"readwrite")
942
def host_dbus_property(self, value=None):
1509
943
if value is None: # get
1510
944
return dbus.String(self.host)
1511
self.host = unicode(value)
1512
1513
# Created - property
1514
@dbus_service_property(_interface, signature="s", access="read")
1515
def Created_dbus_property(self):
1516
return datetime_to_dbus(self.created)
1517
1518
# LastEnabled - property
1519
@dbus_service_property(_interface, signature="s", access="read")
1520
def LastEnabled_dbus_property(self):
1521
return datetime_to_dbus(self.last_enabled)
1522
1523
# Enabled - property
1524
@dbus_service_property(_interface, signature="b",
1525
access="readwrite")
1526
def Enabled_dbus_property(self, value=None):
945
self.host = value
946
# Emit D-Bus signal
947
self.PropertyChanged(dbus.String(u"host"),
948
dbus.String(value, variant_level=1))
949
950
# created - property
951
@dbus_service_property(_interface, signature=u"s", access=u"read")
952
def created_dbus_property(self):
953
return dbus.String(self._datetime_to_dbus(self.created))
954
955
# last_enabled - property
956
@dbus_service_property(_interface, signature=u"s", access=u"read")
957
def last_enabled_dbus_property(self):
958
if self.last_enabled is None:
959
return dbus.String(u"")
960
return dbus.String(self._datetime_to_dbus(self.last_enabled))
961
962
# enabled - property
963
@dbus_service_property(_interface, signature=u"b",
964
access=u"readwrite")
965
def enabled_dbus_property(self, value=None):
1527
966
if value is None: # get
1528
967
return dbus.Boolean(self.enabled)
1529
968
if value:
1531
970
else:
1532
971
self.disable()
1533
972
1534
# LastCheckedOK - property
1535
@dbus_service_property(_interface, signature="s",
1536
access="readwrite")
1537
def LastCheckedOK_dbus_property(self, value=None):
973
# last_checked_ok - property
974
@dbus_service_property(_interface, signature=u"s",
975
access=u"readwrite")
976
def last_checked_ok_dbus_property(self, value=None):
1538
977
if value is not None:
1539
978
self.checked_ok()
1540
979
return
1541
return datetime_to_dbus(self.last_checked_ok)
1542
1543
# LastCheckerStatus - property
1544
@dbus_service_property(_interface, signature="n",
1545
access="read")
1546
def LastCheckerStatus_dbus_property(self):
1547
return dbus.Int16(self.last_checker_status)
1548
1549
# Expires - property
1550
@dbus_service_property(_interface, signature="s", access="read")
1551
def Expires_dbus_property(self):
1552
return datetime_to_dbus(self.expires)
1553
1554
# LastApprovalRequest - property
1555
@dbus_service_property(_interface, signature="s", access="read")
1556
def LastApprovalRequest_dbus_property(self):
1557
return datetime_to_dbus(self.last_approval_request)
1558
1559
# Timeout - property
1560
@dbus_service_property(_interface, signature="t",
1561
access="readwrite")
1562
def Timeout_dbus_property(self, value=None):
980
if self.last_checked_ok is None:
981
return dbus.String(u"")
982
return dbus.String(self._datetime_to_dbus(self
983
.last_checked_ok))
984
985
# timeout - property
986
@dbus_service_property(_interface, signature=u"t",
987
access=u"readwrite")
988
def timeout_dbus_property(self, value=None):
1563
989
if value is None: # get
1564
990
return dbus.UInt64(self.timeout_milliseconds())
1565
old_timeout = self.timeout
1566
991
self.timeout = datetime.timedelta(0, 0, 0, value)
1567
# Reschedule disabling
1568
if self.enabled:
1569
now = datetime.datetime.utcnow()
1570
self.expires += self.timeout - old_timeout
1571
if self.expires <= now:
1572
# The timeout has passed
1573
self.disable()
1574
else:
1575
if (getattr(self, "disable_initiator_tag", None)
1576
is None):
1577
return
1578
gobject.source_remove(self.disable_initiator_tag)
1579
self.disable_initiator_tag = (
1580
gobject.timeout_add(
1581
timedelta_to_milliseconds(self.expires - now),
1582
self.disable))
1583
1584
# ExtendedTimeout - property
1585
@dbus_service_property(_interface, signature="t",
1586
access="readwrite")
1587
def ExtendedTimeout_dbus_property(self, value=None):
1588
if value is None: # get
1589
return dbus.UInt64(self.extended_timeout_milliseconds())
1590
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1591
1592
# Interval - property
1593
@dbus_service_property(_interface, signature="t",
1594
access="readwrite")
1595
def Interval_dbus_property(self, value=None):
992
# Emit D-Bus signal
993
self.PropertyChanged(dbus.String(u"timeout"),
994
dbus.UInt64(value, variant_level=1))
995
if getattr(self, u"disable_initiator_tag", None) is None:
996
return
997
# Reschedule timeout
998
gobject.source_remove(self.disable_initiator_tag)
999
self.disable_initiator_tag = None
1000
time_to_die = (self.
1001
_timedelta_to_milliseconds((self
1002
.last_checked_ok
1003
+ self.timeout)
1004
- datetime.datetime
1005
.utcnow()))
1006
if time_to_die <= 0:
1007
# The timeout has passed
1008
self.disable()
1009
else:
1010
self.disable_initiator_tag = (gobject.timeout_add
1011
(time_to_die, self.disable))
1012
1013
# interval - property
1014
@dbus_service_property(_interface, signature=u"t",
1015
access=u"readwrite")
1016
def interval_dbus_property(self, value=None):
1596
1017
if value is None: # get
1597
1018
return dbus.UInt64(self.interval_milliseconds())
1598
1019
self.interval = datetime.timedelta(0, 0, 0, value)
1599
if getattr(self, "checker_initiator_tag", None) is None:
1020
# Emit D-Bus signal
1021
self.PropertyChanged(dbus.String(u"interval"),
1022
dbus.UInt64(value, variant_level=1))
1023
if getattr(self, u"checker_initiator_tag", None) is None:
1600
1024
return
1601
if self.enabled:
1602
# Reschedule checker run
1603
gobject.source_remove(self.checker_initiator_tag)
1604
self.checker_initiator_tag = (gobject.timeout_add
1605
(value, self.start_checker))
1606
self.start_checker() # Start one now, too
1607
1608
# Checker - property
1609
@dbus_service_property(_interface, signature="s",
1610
access="readwrite")
1611
def Checker_dbus_property(self, value=None):
1025
# Reschedule checker run
1026
gobject.source_remove(self.checker_initiator_tag)
1027
self.checker_initiator_tag = (gobject.timeout_add
1028
(value, self.start_checker))
1029
self.start_checker() # Start one now, too
1030
1031
# checker - property
1032
@dbus_service_property(_interface, signature=u"s",
1033
access=u"readwrite")
1034
def checker_dbus_property(self, value=None):
1612
1035
if value is None: # get
1613
1036
return dbus.String(self.checker_command)
1614
self.checker_command = unicode(value)
1037
self.checker_command = value
1038
# Emit D-Bus signal
1039
self.PropertyChanged(dbus.String(u"checker"),
1040
dbus.String(self.checker_command,
1041
variant_level=1))
1615
1042
1616
# CheckerRunning - property
1617
@dbus_service_property(_interface, signature="b",
1618
access="readwrite")
1619
def CheckerRunning_dbus_property(self, value=None):
1043
# checker_running - property
1044
@dbus_service_property(_interface, signature=u"b",
1045
access=u"readwrite")
1046
def checker_running_dbus_property(self, value=None):
1620
1047
if value is None: # get
1621
1048
return dbus.Boolean(self.checker is not None)
1622
1049
if value:
1624
1051
else:
1625
1052
self.stop_checker()
1626
1053
1627
# ObjectPath - property
1628
@dbus_service_property(_interface, signature="o", access="read")
1629
def ObjectPath_dbus_property(self):
1054
# object_path - property
1055
@dbus_service_property(_interface, signature=u"o", access=u"read")
1056
def object_path_dbus_property(self):
1630
1057
return self.dbus_object_path # is already a dbus.ObjectPath
1631
1058
1632
# Secret = property
1633
@dbus_service_property(_interface, signature="ay",
1634
access="write", byte_arrays=True)
1635
def Secret_dbus_property(self, value):
1059
# secret = property
1060
@dbus_service_property(_interface, signature=u"ay",
1061
access=u"write", byte_arrays=True)
1062
def secret_dbus_property(self, value):
1636
1063
self.secret = str(value)
1637
1064
1638
1065
del _interface
1644
1071
self._pipe.send(('init', fpr, address))
1645
1072
if not self._pipe.recv():
1646
1073
raise KeyError()
1647
1074
1648
1075
def __getattribute__(self, name):
1649
if name == '_pipe':
1076
if(name == '_pipe'):
1650
1077
return super(ProxyClient, self).__getattribute__(name)
1651
1078
self._pipe.send(('getattr', name))
1652
1079
data = self._pipe.recv()
1657
1084
self._pipe.send(('funcall', name, args, kwargs))
1658
1085
return self._pipe.recv()[1]
1659
1086
return func
1660
1087
1661
1088
def __setattr__(self, name, value):
1662
if name == '_pipe':
1089
if(name == '_pipe'):
1663
1090
return super(ProxyClient, self).__setattr__(name, value)
1664
1091
self._pipe.send(('setattr', name, value))
1665
1092
1672
1099
1673
1100
def handle(self):
1674
1101
with contextlib.closing(self.server.child_pipe) as child_pipe:
1675
logger.info("TCP connection from: %s",
1102
logger.info(u"TCP connection from: %s",
1676
1103
unicode(self.client_address))
1677
logger.debug("Pipe FD: %d",
1104
logger.debug(u"Pipe FD: %d",
1678
1105
self.server.child_pipe.fileno())
1679
1106
1680
1107
session = (gnutls.connection
1681
1108
.ClientSession(self.request,
1682
1109
gnutls.connection
1683
1110
.X509Credentials()))
1684
1111
1685
1112
# Note: gnutls.connection.X509Credentials is really a
1686
1113
# generic GnuTLS certificate credentials object so long as
1687
1114
# no X.509 keys are added to it. Therefore, we can use it
1688
1115
# here despite using OpenPGP certificates.
1689
1690
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1691
# "+AES-256-CBC", "+SHA1",
1692
# "+COMP-NULL", "+CTYPE-OPENPGP",
1693
# "+DHE-DSS"))
1116
1117
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1118
# u"+AES-256-CBC", u"+SHA1",
1119
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1120
# u"+DHE-DSS"))
1694
1121
# Use a fallback default, since this MUST be set.
1695
1122
priority = self.server.gnutls_priority
1696
1123
if priority is None:
1697
priority = "NORMAL"
1124
priority = u"NORMAL"
1698
1125
(gnutls.library.functions
1699
1126
.gnutls_priority_set_direct(session._c_object,
1700
1127
priority, None))
1701
1128
1702
1129
# Start communication using the Mandos protocol
1703
1130
# Get protocol number
1704
1131
line = self.request.makefile().readline()
1705
logger.debug("Protocol version: %r", line)
1132
logger.debug(u"Protocol version: %r", line)
1706
1133
try:
1707
1134
if int(line.strip().split()[0]) > 1:
1708
raise RuntimeError(line)
1709
except (ValueError, IndexError, RuntimeError) as error:
1710
logger.error("Unknown protocol version: %s", error)
1135
raise RuntimeError
1136
except (ValueError, IndexError, RuntimeError), error:
1137
logger.error(u"Unknown protocol version: %s", error)
1711
1138
return
1712
1139
1713
1140
# Start GnuTLS connection
1714
1141
try:
1715
1142
session.handshake()
1716
except gnutls.errors.GNUTLSError as error:
1717
logger.warning("Handshake failed: %s", error)
1143
except gnutls.errors.GNUTLSError, error:
1144
logger.warning(u"Handshake failed: %s", error)
1718
1145
# Do not run session.bye() here: the session is not
1719
1146
# established. Just abandon the request.
1720
1147
return
1721
logger.debug("Handshake succeeded")
1722
1148
logger.debug(u"Handshake succeeded")
1149
1723
1150
approval_required = False
1724
1151
try:
1725
1152
try:
1726
1153
fpr = self.fingerprint(self.peer_certificate
1727
1154
(session))
1728
except (TypeError,
1729
gnutls.errors.GNUTLSError) as error:
1730
logger.warning("Bad certificate: %s", error)
1155
except (TypeError, gnutls.errors.GNUTLSError), error:
1156
logger.warning(u"Bad certificate: %s", error)
1731
1157
return
1732
logger.debug("Fingerprint: %s", fpr)
1733
1158
logger.debug(u"Fingerprint: %s", fpr)
1159
1734
1160
try:
1735
1161
client = ProxyClient(child_pipe, fpr,
1736
1162
self.client_address)
1737
1163
except KeyError:
1738
1164
return
1739
1165
1740
if client.approval_delay:
1741
delay = client.approval_delay
1166
if client.approved_delay:
1167
delay = client.approved_delay
1742
1168
client.approvals_pending += 1
1743
1169
approval_required = True
1744
1170
1745
1171
while True:
1746
1172
if not client.enabled:
1747
logger.info("Client %s is disabled",
1173
logger.warning(u"Client %s is disabled",
1748
1174
client.name)
1749
1175
if self.server.use_dbus:
1750
1176
# Emit D-Bus signal
1751
client.Rejected("Disabled")
1177
client.Rejected("Disabled")
1752
1178
return
1753
1179
1754
if client.approved or not client.approval_delay:
1180
if client._approved or not client.approved_delay:
1755
1181
#We are approved or approval is disabled
1756
1182
break
1757
elif client.approved is None:
1758
logger.info("Client %s needs approval",
1183
elif client._approved is None:
1184
logger.info(u"Client %s need approval",
1759
1185
client.name)
1760
1186
if self.server.use_dbus:
1761
1187
# Emit D-Bus signal
1762
1188
client.NeedApproval(
1763
client.approval_delay_milliseconds(),
1189
client.approved_delay_milliseconds(),
1764
1190
client.approved_by_default)
1765
1191
else:
1766
logger.warning("Client %s was not approved",
1192
logger.warning(u"Client %s was not approved",
1767
1193
client.name)
1768
1194
if self.server.use_dbus:
1769
1195
# Emit D-Bus signal
1770
client.Rejected("Denied")
1196
client.Rejected("Disapproved")
1771
1197
return
1772
1198
1773
1199
#wait until timeout or approved
1200
#x = float(client._timedelta_to_milliseconds(delay))
1774
1201
time = datetime.datetime.now()
1775
1202
client.changedstate.acquire()
1776
client.changedstate.wait(
1777
float(timedelta_to_milliseconds(delay)
1778
/ 1000))
1203
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1779
1204
client.changedstate.release()
1780
1205
time2 = datetime.datetime.now()
1781
1206
if (time2 - time) >= delay:
1785
1210
client.name)
1786
1211
if self.server.use_dbus:
1787
1212
# Emit D-Bus signal
1788
client.Rejected("Approval timed out")
1213
client.Rejected("Time out")
1789
1214
return
1790
1215
else:
1791
1216
break
1794
1219
1795
1220
sent_size = 0
1796
1221
while sent_size < len(client.secret):
1797
try:
1798
sent = session.send(client.secret[sent_size:])
1799
except gnutls.errors.GNUTLSError as error:
1800
logger.warning("gnutls send failed",
1801
exc_info=error)
1802
return
1803
logger.debug("Sent: %d, remaining: %d",
1222
# XXX handle session exception
1223
sent = session.send(client.secret[sent_size:])
1224
logger.debug(u"Sent: %d, remaining: %d",
1804
1225
sent, len(client.secret)
1805
1226
- (sent_size + sent))
1806
1227
sent_size += sent
1807
1808
logger.info("Sending secret to %s", client.name)
1809
# bump the timeout using extended_timeout
1810
client.bump_timeout(client.extended_timeout)
1228
1229
logger.info(u"Sending secret to %s", client.name)
1230
# bump the timeout as if seen
1231
client.checked_ok()
1811
1232
if self.server.use_dbus:
1812
1233
# Emit D-Bus signal
1813
1234
client.GotSecret()
1815
1236
finally:
1816
1237
if approval_required:
1817
1238
client.approvals_pending -= 1
1818
try:
1819
session.bye()
1820
except gnutls.errors.GNUTLSError as error:
1821
logger.warning("GnuTLS bye failed",
1822
exc_info=error)
1239
session.bye()
1823
1240
1824
1241
@staticmethod
1825
1242
def peer_certificate(session):
1835
1252
.gnutls_certificate_get_peers
1836
1253
(session._c_object, ctypes.byref(list_size)))
1837
1254
if not bool(cert_list) and list_size.value != 0:
1838
raise gnutls.errors.GNUTLSError("error getting peer"
1839
" certificate")
1255
raise gnutls.errors.GNUTLSError(u"error getting peer"
1256
u" certificate")
1840
1257
if list_size.value == 0:
1841
1258
return None
1842
1259
cert = cert_list[0]
1868
1285
if crtverify.value != 0:
1869
1286
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1870
1287
raise (gnutls.errors.CertificateSecurityError
1871
("Verify failed"))
1288
(u"Verify failed"))
1872
1289
# New buffer for the fingerprint
1873
1290
buf = ctypes.create_string_buffer(20)
1874
1291
buf_len = ctypes.c_size_t()
1881
1298
# Convert the buffer to a Python bytestring
1882
1299
fpr = ctypes.string_at(buf, buf_len.value)
1883
1300
# Convert the bytestring to hexadecimal notation
1884
hex_fpr = binascii.hexlify(fpr).upper()
1301
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1885
1302
return hex_fpr
1886
1303
1887
1304
1890
1307
def sub_process_main(self, request, address):
1891
1308
try:
1892
1309
self.finish_request(request, address)
1893
except Exception:
1310
except:
1894
1311
self.handle_error(request, address)
1895
1312
self.close_request(request)
1896
1313
1897
1314
def process_request(self, request, address):
1898
1315
"""Start a new process to process the request."""
1899
proc = multiprocessing.Process(target = self.sub_process_main,
1900
args = (request, address))
1901
proc.start()
1902
return proc
1903
1316
multiprocessing.Process(target = self.sub_process_main,
1317
args = (request, address)).start()
1904
1318
1905
1319
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1906
1320
""" adds a pipe to the MixIn """
1910
1324
This function creates a new pipe in self.pipe
1911
1325
"""
1912
1326
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1913
1914
proc = MultiprocessingMixIn.process_request(self, request,
1915
client_address)
1916
self.child_pipe.close()
1917
self.add_pipe(parent_pipe, proc)
1918
1919
def add_pipe(self, parent_pipe, proc):
1327
1328
super(MultiprocessingMixInWithPipe,
1329
self).process_request(request, client_address)
1330
self.add_pipe(parent_pipe)
1331
def add_pipe(self, parent_pipe):
1920
1332
"""Dummy function; override as necessary"""
1921
raise NotImplementedError()
1922
1333
pass
1923
1334
1924
1335
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1925
1336
socketserver.TCPServer, object):
1931
1342
use_ipv6: Boolean; to use IPv6 or not
1932
1343
"""
1933
1344
def __init__(self, server_address, RequestHandlerClass,
1934
interface=None, use_ipv6=True, socketfd=None):
1935
"""If socketfd is set, use that file descriptor instead of
1936
creating a new one with socket.socket().
1937
"""
1345
interface=None, use_ipv6=True):
1938
1346
self.interface = interface
1939
1347
if use_ipv6:
1940
1348
self.address_family = socket.AF_INET6
1941
if socketfd is not None:
1942
# Save the file descriptor
1943
self.socketfd = socketfd
1944
# Save the original socket.socket() function
1945
self.socket_socket = socket.socket
1946
# To implement --socket, we monkey patch socket.socket.
1947
#
1948
# (When socketserver.TCPServer is a new-style class, we
1949
# could make self.socket into a property instead of monkey
1950
# patching socket.socket.)
1951
#
1952
# Create a one-time-only replacement for socket.socket()
1953
@functools.wraps(socket.socket)
1954
def socket_wrapper(*args, **kwargs):
1955
# Restore original function so subsequent calls are
1956
# not affected.
1957
socket.socket = self.socket_socket
1958
del self.socket_socket
1959
# This time only, return a new socket object from the
1960
# saved file descriptor.
1961
return socket.fromfd(self.socketfd, *args, **kwargs)
1962
# Replace socket.socket() function with wrapper
1963
socket.socket = socket_wrapper
1964
# The socketserver.TCPServer.__init__ will call
1965
# socket.socket(), which might be our replacement,
1966
# socket_wrapper(), if socketfd was set.
1967
1349
socketserver.TCPServer.__init__(self, server_address,
1968
1350
RequestHandlerClass)
1969
1970
1351
def server_bind(self):
1971
1352
"""This overrides the normal server_bind() function
1972
1353
to bind to an interface if one was specified, and also NOT to
1973
1354
bind to an address or port if they were not specified."""
1974
1355
if self.interface is not None:
1975
1356
if SO_BINDTODEVICE is None:
1976
logger.error("SO_BINDTODEVICE does not exist;"
1977
" cannot bind to interface %s",
1357
logger.error(u"SO_BINDTODEVICE does not exist;"
1358
u" cannot bind to interface %s",
1978
1359
self.interface)
1979
1360
else:
1980
1361
try:
1981
1362
self.socket.setsockopt(socket.SOL_SOCKET,
1982
1363
SO_BINDTODEVICE,
1983
str(self.interface + '\0'))
1984
except socket.error as error:
1985
if error.errno == errno.EPERM:
1986
logger.error("No permission to bind to"
1987
" interface %s", self.interface)
1988
elif error.errno == errno.ENOPROTOOPT:
1989
logger.error("SO_BINDTODEVICE not available;"
1990
" cannot bind to interface %s",
1991
self.interface)
1992
elif error.errno == errno.ENODEV:
1993
logger.error("Interface %s does not exist,"
1994
" cannot bind", self.interface)
1364
str(self.interface
1365
+ u'\0'))
1366
except socket.error, error:
1367
if error[0] == errno.EPERM:
1368
logger.error(u"No permission to"
1369
u" bind to interface %s",
1370
self.interface)
1371
elif error[0] == errno.ENOPROTOOPT:
1372
logger.error(u"SO_BINDTODEVICE not available;"
1373
u" cannot bind to interface %s",
1374
self.interface)
1995
1375
else:
1996
1376
raise
1997
1377
# Only bind(2) the socket if we really need to.
1998
1378
if self.server_address[0] or self.server_address[1]:
1999
1379
if not self.server_address[0]:
2000
1380
if self.address_family == socket.AF_INET6:
2001
any_address = "::" # in6addr_any
1381
any_address = u"::" # in6addr_any
2002
1382
else:
2003
any_address = "0.0.0.0" # INADDR_ANY
1383
any_address = socket.INADDR_ANY
2004
1384
self.server_address = (any_address,
2005
1385
self.server_address[1])
2006
1386
elif not self.server_address[1]:
2027
1407
"""
2028
1408
def __init__(self, server_address, RequestHandlerClass,
2029
1409
interface=None, use_ipv6=True, clients=None,
2030
gnutls_priority=None, use_dbus=True, socketfd=None):
1410
gnutls_priority=None, use_dbus=True):
2031
1411
self.enabled = False
2032
1412
self.clients = clients
2033
1413
if self.clients is None:
2034
self.clients = {}
1414
self.clients = set()
2035
1415
self.use_dbus = use_dbus
2036
1416
self.gnutls_priority = gnutls_priority
2037
1417
IPv6_TCPServer.__init__(self, server_address,
2038
1418
RequestHandlerClass,
2039
1419
interface = interface,
2040
use_ipv6 = use_ipv6,
2041
socketfd = socketfd)
1420
use_ipv6 = use_ipv6)
2042
1421
def server_activate(self):
2043
1422
if self.enabled:
2044
1423
return socketserver.TCPServer.server_activate(self)
2045
2046
1424
def enable(self):
2047
1425
self.enabled = True
2048
2049
def add_pipe(self, parent_pipe, proc):
1426
def add_pipe(self, parent_pipe):
2050
1427
# Call "handle_ipc" for both data and EOF events
2051
1428
gobject.io_add_watch(parent_pipe.fileno(),
2052
1429
gobject.IO_IN | gobject.IO_HUP,
2053
1430
functools.partial(self.handle_ipc,
2054
parent_pipe =
2055
parent_pipe,
2056
proc = proc))
2057
1431
parent_pipe = parent_pipe))
1432
2058
1433
def handle_ipc(self, source, condition, parent_pipe=None,
2059
proc = None, client_object=None):
2060
# error, or the other end of multiprocessing.Pipe has closed
2061
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2062
# Wait for other process to exit
2063
proc.join()
2064
return False
1434
client_object=None):
1435
condition_names = {
1436
gobject.IO_IN: u"IN", # There is data to read.
1437
gobject.IO_OUT: u"OUT", # Data can be written (without
1438
# blocking).
1439
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1440
gobject.IO_ERR: u"ERR", # Error condition.
1441
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1442
# broken, usually for pipes and
1443
# sockets).
1444
}
1445
conditions_string = ' | '.join(name
1446
for cond, name in
1447
condition_names.iteritems()
1448
if cond & condition)
1449
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1450
conditions_string)
2065
1451
2066
1452
# Read a request from the child
2067
1453
request = parent_pipe.recv()
2071
1457
fpr = request[1]
2072
1458
address = request[2]
2073
1459
2074
for c in self.clients.itervalues():
1460
for c in self.clients:
2075
1461
if c.fingerprint == fpr:
2076
1462
client = c
2077
1463
break
2078
1464
else:
2079
logger.info("Client not found for fingerprint: %s, ad"
2080
"dress: %s", fpr, address)
1465
logger.warning(u"Client not found for fingerprint: %s, ad"
1466
u"dress: %s", fpr, address)
2081
1467
if self.use_dbus:
2082
1468
# Emit D-Bus signal
2083
mandos_dbus_service.ClientNotFound(fpr,
2084
address[0])
1469
mandos_dbus_service.ClientNotFound(fpr, address)
2085
1470
parent_pipe.send(False)
2086
1471
return False
2087
1472
2088
1473
gobject.io_add_watch(parent_pipe.fileno(),
2089
1474
gobject.IO_IN | gobject.IO_HUP,
2090
1475
functools.partial(self.handle_ipc,
2091
parent_pipe =
2092
parent_pipe,
2093
proc = proc,
2094
client_object =
2095
client))
1476
parent_pipe = parent_pipe,
1477
client_object = client))
2096
1478
parent_pipe.send(True)
2097
# remove the old hook in favor of the new above hook on
2098
# same fileno
1479
# remove the old hook in favor of the new above hook on same fileno
2099
1480
return False
2100
1481
if command == 'funcall':
2101
1482
funcname = request[1]
2102
1483
args = request[2]
2103
1484
kwargs = request[3]
2104
1485
2105
parent_pipe.send(('data', getattr(client_object,
2106
funcname)(*args,
2107
**kwargs)))
2108
1486
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1487
2109
1488
if command == 'getattr':
2110
1489
attrname = request[1]
2111
1490
if callable(client_object.__getattribute__(attrname)):
2112
1491
parent_pipe.send(('function',))
2113
1492
else:
2114
parent_pipe.send(('data', client_object
2115
.__getattribute__(attrname)))
2116
1493
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1494
2117
1495
if command == 'setattr':
2118
1496
attrname = request[1]
2119
1497
value = request[2]
2120
1498
setattr(client_object, attrname, value)
2121
1499
2122
1500
return True
2123
1501
2124
1502
2125
def rfc3339_duration_to_delta(duration):
2126
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2127
2128
>>> rfc3339_duration_to_delta("P7D")
2129
datetime.timedelta(7)
2130
>>> rfc3339_duration_to_delta("PT60S")
2131
datetime.timedelta(0, 60)
2132
>>> rfc3339_duration_to_delta("PT60M")
2133
datetime.timedelta(0, 3600)
2134
>>> rfc3339_duration_to_delta("PT24H")
2135
datetime.timedelta(1)
2136
>>> rfc3339_duration_to_delta("P1W")
2137
datetime.timedelta(7)
2138
>>> rfc3339_duration_to_delta("PT5M30S")
2139
datetime.timedelta(0, 330)
2140
>>> rfc3339_duration_to_delta("P1DT3M20S")
2141
datetime.timedelta(1, 200)
2142
"""
2143
2144
# Parsing an RFC 3339 duration with regular expressions is not
2145
# possible - there would have to be multiple places for the same
2146
# values, like seconds. The current code, while more esoteric, is
2147
# cleaner without depending on a parsing library. If Python had a
2148
# built-in library for parsing we would use it, but we'd like to
2149
# avoid excessive use of external libraries.
2150
2151
# New type for defining tokens, syntax, and semantics all-in-one
2152
Token = collections.namedtuple("Token",
2153
("regexp", # To match token; if
2154
# "value" is not None,
2155
# must have a "group"
2156
# containing digits
2157
"value", # datetime.timedelta or
2158
# None
2159
"followers")) # Tokens valid after
2160
# this token
2161
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2162
# the "duration" ABNF definition in RFC 3339, Appendix A.
2163
token_end = Token(re.compile(r"$"), None, frozenset())
2164
token_second = Token(re.compile(r"(\d+)S"),
2165
datetime.timedelta(seconds=1),
2166
frozenset((token_end,)))
2167
token_minute = Token(re.compile(r"(\d+)M"),
2168
datetime.timedelta(minutes=1),
2169
frozenset((token_second, token_end)))
2170
token_hour = Token(re.compile(r"(\d+)H"),
2171
datetime.timedelta(hours=1),
2172
frozenset((token_minute, token_end)))
2173
token_time = Token(re.compile(r"T"),
2174
None,
2175
frozenset((token_hour, token_minute,
2176
token_second)))
2177
token_day = Token(re.compile(r"(\d+)D"),
2178
datetime.timedelta(days=1),
2179
frozenset((token_time, token_end)))
2180
token_month = Token(re.compile(r"(\d+)M"),
2181
datetime.timedelta(weeks=4),
2182
frozenset((token_day, token_end)))
2183
token_year = Token(re.compile(r"(\d+)Y"),
2184
datetime.timedelta(weeks=52),
2185
frozenset((token_month, token_end)))
2186
token_week = Token(re.compile(r"(\d+)W"),
2187
datetime.timedelta(weeks=1),
2188
frozenset((token_end,)))
2189
token_duration = Token(re.compile(r"P"), None,
2190
frozenset((token_year, token_month,
2191
token_day, token_time,
2192
token_week))),
2193
# Define starting values
2194
value = datetime.timedelta() # Value so far
2195
found_token = None
2196
followers = frozenset(token_duration,) # Following valid tokens
2197
s = duration # String left to parse
2198
# Loop until end token is found
2199
while found_token is not token_end:
2200
# Search for any currently valid tokens
2201
for token in followers:
2202
match = token.regexp.match(s)
2203
if match is not None:
2204
# Token found
2205
if token.value is not None:
2206
# Value found, parse digits
2207
factor = int(match.group(1), 10)
2208
# Add to value so far
2209
value += factor * token.value
2210
# Strip token from string
2211
s = token.regexp.sub("", s, 1)
2212
# Go to found token
2213
found_token = token
2214
# Set valid next tokens
2215
followers = found_token.followers
2216
break
2217
else:
2218
# No currently valid tokens were found
2219
raise ValueError("Invalid RFC 3339 duration")
2220
# End token found
2221
return value
2222
2223
2224
1503
def string_to_delta(interval):
2225
1504
"""Parse a string and return a datetime.timedelta
2226
1505
2227
>>> string_to_delta('7d')
1506
>>> string_to_delta(u'7d')
2228
1507
datetime.timedelta(7)
2229
>>> string_to_delta('60s')
1508
>>> string_to_delta(u'60s')
2230
1509
datetime.timedelta(0, 60)
2231
>>> string_to_delta('60m')
1510
>>> string_to_delta(u'60m')
2232
1511
datetime.timedelta(0, 3600)
2233
>>> string_to_delta('24h')
1512
>>> string_to_delta(u'24h')
2234
1513
datetime.timedelta(1)
2235
>>> string_to_delta('1w')
1514
>>> string_to_delta(u'1w')
2236
1515
datetime.timedelta(7)
2237
>>> string_to_delta('5m 30s')
1516
>>> string_to_delta(u'5m 30s')
2238
1517
datetime.timedelta(0, 330)
2239
1518
"""
2240
2241
try:
2242
return rfc3339_duration_to_delta(interval)
2243
except ValueError:
2244
pass
2245
2246
1519
timevalue = datetime.timedelta(0)
2247
1520
for s in interval.split():
2248
1521
try:
2249
1522
suffix = unicode(s[-1])
2250
1523
value = int(s[:-1])
2251
if suffix == "d":
1524
if suffix == u"d":
2252
1525
delta = datetime.timedelta(value)
2253
elif suffix == "s":
1526
elif suffix == u"s":
2254
1527
delta = datetime.timedelta(0, value)
2255
elif suffix == "m":
1528
elif suffix == u"m":
2256
1529
delta = datetime.timedelta(0, 0, 0, 0, value)
2257
elif suffix == "h":
1530
elif suffix == u"h":
2258
1531
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2259
elif suffix == "w":
1532
elif suffix == u"w":
2260
1533
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2261
1534
else:
2262
raise ValueError("Unknown suffix {0!r}"
2263
.format(suffix))
2264
except IndexError as e:
2265
raise ValueError(*(e.args))
1535
raise ValueError(u"Unknown suffix %r" % suffix)
1536
except (ValueError, IndexError), e:
1537
raise ValueError(e.message)
2266
1538
timevalue += delta
2267
1539
return timevalue
2268
1540
2269
1541
1542
def if_nametoindex(interface):
1543
"""Call the C function if_nametoindex(), or equivalent
1544
1545
Note: This function cannot accept a unicode string."""
1546
global if_nametoindex
1547
try:
1548
if_nametoindex = (ctypes.cdll.LoadLibrary
1549
(ctypes.util.find_library(u"c"))
1550
.if_nametoindex)
1551
except (OSError, AttributeError):
1552
logger.warning(u"Doing if_nametoindex the hard way")
1553
def if_nametoindex(interface):
1554
"Get an interface index the hard way, i.e. using fcntl()"
1555
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1556
with contextlib.closing(socket.socket()) as s:
1557
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1558
struct.pack(str(u"16s16x"),
1559
interface))
1560
interface_index = struct.unpack(str(u"I"),
1561
ifreq[16:20])[0]
1562
return interface_index
1563
return if_nametoindex(interface)
1564
1565
2270
1566
def daemon(nochdir = False, noclose = False):
2271
1567
"""See daemon(3). Standard BSD Unix function.
2272
1568
2275
1571
sys.exit()
2276
1572
os.setsid()
2277
1573
if not nochdir:
2278
os.chdir("/")
1574
os.chdir(u"/")
2279
1575
if os.fork():
2280
1576
sys.exit()
2281
1577
if not noclose:
2282
1578
# Close all standard open file descriptors
2283
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1579
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2284
1580
if not stat.S_ISCHR(os.fstat(null).st_mode):
2285
1581
raise OSError(errno.ENODEV,
2286
"{0} not a character device"
2287
.format(os.devnull))
1582
u"%s not a character device"
1583
% os.path.devnull)
2288
1584
os.dup2(null, sys.stdin.fileno())
2289
1585
os.dup2(null, sys.stdout.fileno())
2290
1586
os.dup2(null, sys.stderr.fileno())
2297
1593
##################################################################
2298
1594
# Parsing of options, both command line and config file
2299
1595
2300
parser = argparse.ArgumentParser()
2301
parser.add_argument("-v", "--version", action="version",
2302
version = "%(prog)s {0}".format(version),
2303
help="show version number and exit")
2304
parser.add_argument("-i", "--interface", metavar="IF",
2305
help="Bind to interface IF")
2306
parser.add_argument("-a", "--address",
2307
help="Address to listen for requests on")
2308
parser.add_argument("-p", "--port", type=int,
2309
help="Port number to receive requests on")
2310
parser.add_argument("--check", action="store_true",
2311
help="Run self-test")
2312
parser.add_argument("--debug", action="store_true",
2313
help="Debug mode; run in foreground and log"
2314
" to terminal", default=None)
2315
parser.add_argument("--debuglevel", metavar="LEVEL",
2316
help="Debug level for stdout output")
2317
parser.add_argument("--priority", help="GnuTLS"
2318
" priority string (see GnuTLS documentation)")
2319
parser.add_argument("--servicename",
2320
metavar="NAME", help="Zeroconf service name")
2321
parser.add_argument("--configdir",
2322
default="/etc/mandos", metavar="DIR",
2323
help="Directory to search for configuration"
2324
" files")
2325
parser.add_argument("--no-dbus", action="store_false",
2326
dest="use_dbus", help="Do not provide D-Bus"
2327
" system bus interface", default=None)
2328
parser.add_argument("--no-ipv6", action="store_false",
2329
dest="use_ipv6", help="Do not use IPv6",
2330
default=None)
2331
parser.add_argument("--no-restore", action="store_false",
2332
dest="restore", help="Do not restore stored"
2333
" state", default=None)
2334
parser.add_argument("--socket", type=int,
2335
help="Specify a file descriptor to a network"
2336
" socket to use instead of creating one")
2337
parser.add_argument("--statedir", metavar="DIR",
2338
help="Directory to save/restore state in")
2339
parser.add_argument("--foreground", action="store_true",
2340
help="Run in foreground", default=None)
2341
2342
options = parser.parse_args()
1596
parser = optparse.OptionParser(version = "%%prog %s" % version)
1597
parser.add_option("-i", u"--interface", type=u"string",
1598
metavar="IF", help=u"Bind to interface IF")
1599
parser.add_option("-a", u"--address", type=u"string",
1600
help=u"Address to listen for requests on")
1601
parser.add_option("-p", u"--port", type=u"int",
1602
help=u"Port number to receive requests on")
1603
parser.add_option("--check", action=u"store_true",
1604
help=u"Run self-test")
1605
parser.add_option("--debug", action=u"store_true",
1606
help=u"Debug mode; run in foreground and log to"
1607
u" terminal")
1608
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1609
u" priority string (see GnuTLS documentation)")
1610
parser.add_option("--servicename", type=u"string",
1611
metavar=u"NAME", help=u"Zeroconf service name")
1612
parser.add_option("--configdir", type=u"string",
1613
default=u"/etc/mandos", metavar=u"DIR",
1614
help=u"Directory to search for configuration"
1615
u" files")
1616
parser.add_option("--no-dbus", action=u"store_false",
1617
dest=u"use_dbus", help=u"Do not provide D-Bus"
1618
u" system bus interface")
1619
parser.add_option("--no-ipv6", action=u"store_false",
1620
dest=u"use_ipv6", help=u"Do not use IPv6")
1621
options = parser.parse_args()[0]
2343
1622
2344
1623
if options.check:
2345
1624
import doctest
2346
fail_count, test_count = doctest.testmod()
2347
sys.exit(os.EX_OK if fail_count == 0 else 1)
1625
doctest.testmod()
1626
sys.exit()
2348
1627
2349
1628
# Default values for config file for server-global settings
2350
server_defaults = { "interface": "",
2351
"address": "",
2352
"port": "",
2353
"debug": "False",
2354
"priority":
2355
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2356
"servicename": "Mandos",
2357
"use_dbus": "True",
2358
"use_ipv6": "True",
2359
"debuglevel": "",
2360
"restore": "True",
2361
"socket": "",
2362
"statedir": "/var/lib/mandos",
2363
"foreground": "False",
1629
server_defaults = { u"interface": u"",
1630
u"address": u"",
1631
u"port": u"",
1632
u"debug": u"False",
1633
u"priority":
1634
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1635
u"servicename": u"Mandos",
1636
u"use_dbus": u"True",
1637
u"use_ipv6": u"True",
2364
1638
}
2365
1639
2366
1640
# Parse config file for server-global settings
2367
1641
server_config = configparser.SafeConfigParser(server_defaults)
2368
1642
del server_defaults
2369
1643
server_config.read(os.path.join(options.configdir,
2370
"mandos.conf"))
1644
u"mandos.conf"))
2371
1645
# Convert the SafeConfigParser object to a dict
2372
1646
server_settings = server_config.defaults()
2373
1647
# Use the appropriate methods on the non-string config options
2374
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2375
server_settings[option] = server_config.getboolean("DEFAULT",
1648
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1649
server_settings[option] = server_config.getboolean(u"DEFAULT",
2376
1650
option)
2377
1651
if server_settings["port"]:
2378
server_settings["port"] = server_config.getint("DEFAULT",
2379
"port")
2380
if server_settings["socket"]:
2381
server_settings["socket"] = server_config.getint("DEFAULT",
2382
"socket")
2383
# Later, stdin will, and stdout and stderr might, be dup'ed
2384
# over with an opened os.devnull. But we don't want this to
2385
# happen with a supplied network socket.
2386
if 0 <= server_settings["socket"] <= 2:
2387
server_settings["socket"] = os.dup(server_settings
2388
["socket"])
1652
server_settings["port"] = server_config.getint(u"DEFAULT",
1653
u"port")
2389
1654
del server_config
2390
1655
2391
1656
# Override the settings from the config file with command line
2392
1657
# options, if set.
2393
for option in ("interface", "address", "port", "debug",
2394
"priority", "servicename", "configdir",
2395
"use_dbus", "use_ipv6", "debuglevel", "restore",
2396
"statedir", "socket", "foreground"):
1658
for option in (u"interface", u"address", u"port", u"debug",
1659
u"priority", u"servicename", u"configdir",
1660
u"use_dbus", u"use_ipv6"):
2397
1661
value = getattr(options, option)
2398
1662
if value is not None:
2399
1663
server_settings[option] = value
2402
1666
for option in server_settings.keys():
2403
1667
if type(server_settings[option]) is str:
2404
1668
server_settings[option] = unicode(server_settings[option])
2405
# Force all boolean options to be boolean
2406
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2407
"foreground"):
2408
server_settings[option] = bool(server_settings[option])
2409
# Debug implies foreground
2410
if server_settings["debug"]:
2411
server_settings["foreground"] = True
2412
1669
# Now we have our good server settings in "server_settings"
2413
1670
2414
1671
##################################################################
2415
1672
2416
1673
# For convenience
2417
debug = server_settings["debug"]
2418
debuglevel = server_settings["debuglevel"]
2419
use_dbus = server_settings["use_dbus"]
2420
use_ipv6 = server_settings["use_ipv6"]
2421
stored_state_path = os.path.join(server_settings["statedir"],
2422
stored_state_file)
2423
foreground = server_settings["foreground"]
2424
2425
if debug:
2426
initlogger(debug, logging.DEBUG)
2427
else:
2428
if not debuglevel:
2429
initlogger(debug)
2430
else:
2431
level = getattr(logging, debuglevel.upper())
2432
initlogger(debug, level)
2433
2434
if server_settings["servicename"] != "Mandos":
1674
debug = server_settings[u"debug"]
1675
use_dbus = server_settings[u"use_dbus"]
1676
use_ipv6 = server_settings[u"use_ipv6"]
1677
1678
if not debug:
1679
syslogger.setLevel(logging.WARNING)
1680
console.setLevel(logging.WARNING)
1681
1682
if server_settings[u"servicename"] != u"Mandos":
2435
1683
syslogger.setFormatter(logging.Formatter
2436
('Mandos ({0}) [%(process)d]:'
2437
' %(levelname)s: %(message)s'
2438
.format(server_settings
2439
["servicename"])))
1684
(u'Mandos (%s) [%%(process)d]:'
1685
u' %%(levelname)s: %%(message)s'
1686
% server_settings[u"servicename"]))
2440
1687
2441
1688
# Parse config file with clients
2442
client_config = configparser.SafeConfigParser(Client
2443
.client_defaults)
2444
client_config.read(os.path.join(server_settings["configdir"],
2445
"clients.conf"))
1689
client_defaults = { u"timeout": u"1h",
1690
u"interval": u"5m",
1691
u"checker": u"fping -q -- %%(host)s",
1692
u"host": u"",
1693
u"approved_delay": u"0s",
1694
u"approved_duration": u"1s",
1695
}
1696
client_config = configparser.SafeConfigParser(client_defaults)
1697
client_config.read(os.path.join(server_settings[u"configdir"],
1698
u"clients.conf"))
2446
1699
2447
1700
global mandos_dbus_service
2448
1701
mandos_dbus_service = None
2449
1702
2450
tcp_server = MandosServer((server_settings["address"],
2451
server_settings["port"]),
1703
tcp_server = MandosServer((server_settings[u"address"],
1704
server_settings[u"port"]),
2452
1705
ClientHandler,
2453
interface=(server_settings["interface"]
2454
or None),
1706
interface=server_settings[u"interface"],
2455
1707
use_ipv6=use_ipv6,
2456
1708
gnutls_priority=
2457
server_settings["priority"],
2458
use_dbus=use_dbus,
2459
socketfd=(server_settings["socket"]
2460
or None))
2461
if not foreground:
2462
pidfilename = "/run/mandos.pid"
2463
if not os.path.isdir("/run/."):
2464
pidfilename = "/var/run/mandos.pid"
2465
pidfile = None
2466
try:
2467
pidfile = open(pidfilename, "w")
2468
except IOError as e:
2469
logger.error("Could not open file %r", pidfilename,
2470
exc_info=e)
1709
server_settings[u"priority"],
1710
use_dbus=use_dbus)
1711
pidfilename = u"/var/run/mandos.pid"
1712
try:
1713
pidfile = open(pidfilename, u"w")
1714
except IOError:
1715
logger.error(u"Could not open file %r", pidfilename)
2471
1716
2472
for name in ("_mandos", "mandos", "nobody"):
1717
try:
1718
uid = pwd.getpwnam(u"_mandos").pw_uid
1719
gid = pwd.getpwnam(u"_mandos").pw_gid
1720
except KeyError:
2473
1721
try:
2474
uid = pwd.getpwnam(name).pw_uid
2475
gid = pwd.getpwnam(name).pw_gid
2476
break
1722
uid = pwd.getpwnam(u"mandos").pw_uid
1723
gid = pwd.getpwnam(u"mandos").pw_gid
2477
1724
except KeyError:
2478
continue
2479
else:
2480
uid = 65534
2481
gid = 65534
1725
try:
1726
uid = pwd.getpwnam(u"nobody").pw_uid
1727
gid = pwd.getpwnam(u"nobody").pw_gid
1728
except KeyError:
1729
uid = 65534
1730
gid = 65534
2482
1731
try:
2483
1732
os.setgid(gid)
2484
1733
os.setuid(uid)
2485
except OSError as error:
2486
if error.errno != errno.EPERM:
2487
raise
1734
except OSError, error:
1735
if error[0] != errno.EPERM:
1736
raise error
2488
1737
1738
# Enable all possible GnuTLS debugging
2489
1739
if debug:
2490
# Enable all possible GnuTLS debugging
2491
2492
1740
# "Use a log level over 10 to enable all debugging options."
2493
1741
# - GnuTLS manual
2494
1742
gnutls.library.functions.gnutls_global_set_log_level(11)
2495
1743
2496
1744
@gnutls.library.types.gnutls_log_func
2497
1745
def debug_gnutls(level, string):
2498
logger.debug("GnuTLS: %s", string[:-1])
1746
logger.debug(u"GnuTLS: %s", string[:-1])
2499
1747
2500
1748
(gnutls.library.functions
2501
1749
.gnutls_global_set_log_function(debug_gnutls))
2502
2503
# Redirect stdin so all checkers get /dev/null
2504
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2505
os.dup2(null, sys.stdin.fileno())
2506
if null > 2:
2507
os.close(null)
2508
2509
# Need to fork before connecting to D-Bus
2510
if not foreground:
2511
# Close all input and output, do double fork, etc.
2512
daemon()
2513
2514
# multiprocessing will use threads, so before we use gobject we
2515
# need to inform gobject that threads will be used.
2516
gobject.threads_init()
2517
1750
2518
1751
global main_loop
2519
1752
# From the Avahi example code
2520
DBusGMainLoop(set_as_default=True)
1753
DBusGMainLoop(set_as_default=True )
2521
1754
main_loop = gobject.MainLoop()
2522
1755
bus = dbus.SystemBus()
2523
1756
# End of Avahi example code
2524
1757
if use_dbus:
2525
1758
try:
2526
bus_name = dbus.service.BusName("se.recompile.Mandos",
1759
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2527
1760
bus, do_not_queue=True)
2528
old_bus_name = (dbus.service.BusName
2529
("se.bsnet.fukt.Mandos", bus,
2530
do_not_queue=True))
2531
except dbus.exceptions.NameExistsException as e:
2532
logger.error("Disabling D-Bus:", exc_info=e)
1761
except dbus.exceptions.NameExistsException, e:
1762
logger.error(unicode(e) + u", disabling D-Bus")
2533
1763
use_dbus = False
2534
server_settings["use_dbus"] = False
1764
server_settings[u"use_dbus"] = False
2535
1765
tcp_server.use_dbus = False
2536
1766
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2537
service = AvahiServiceToSyslog(name =
2538
server_settings["servicename"],
2539
servicetype = "_mandos._tcp",
2540
protocol = protocol, bus = bus)
1767
service = AvahiService(name = server_settings[u"servicename"],
1768
servicetype = u"_mandos._tcp",
1769
protocol = protocol, bus = bus)
2541
1770
if server_settings["interface"]:
2542
1771
service.interface = (if_nametoindex
2543
(str(server_settings["interface"])))
2544
2545
global multiprocessing_manager
2546
multiprocessing_manager = multiprocessing.Manager()
1772
(str(server_settings[u"interface"])))
2547
1773
2548
1774
client_class = Client
2549
1775
if use_dbus:
2550
1776
client_class = functools.partial(ClientDBus, bus = bus)
2551
2552
client_settings = Client.config_parser(client_config)
2553
old_client_settings = {}
2554
clients_data = {}
2555
2556
# This is used to redirect stdout and stderr for checker processes
2557
global wnull
2558
wnull = open(os.devnull, "w") # A writable /dev/null
2559
# Only used if server is running in foreground but not in debug
2560
# mode
2561
if debug or not foreground:
2562
wnull.close()
2563
2564
# Get client data and settings from last running state.
2565
if server_settings["restore"]:
2566
try:
2567
with open(stored_state_path, "rb") as stored_state:
2568
clients_data, old_client_settings = (pickle.load
2569
(stored_state))
2570
os.remove(stored_state_path)
2571
except IOError as e:
2572
if e.errno == errno.ENOENT:
2573
logger.warning("Could not load persistent state: {0}"
2574
.format(os.strerror(e.errno)))
2575
else:
2576
logger.critical("Could not load persistent state:",
2577
exc_info=e)
2578
raise
2579
except EOFError as e:
2580
logger.warning("Could not load persistent state: "
2581
"EOFError:", exc_info=e)
2582
2583
with PGPEngine() as pgp:
2584
for client_name, client in clients_data.iteritems():
2585
# Skip removed clients
2586
if client_name not in client_settings:
2587
continue
2588
2589
# Decide which value to use after restoring saved state.
2590
# We have three different values: Old config file,
2591
# new config file, and saved state.
2592
# New config value takes precedence if it differs from old
2593
# config value, otherwise use saved state.
2594
for name, value in client_settings[client_name].items():
2595
try:
2596
# For each value in new config, check if it
2597
# differs from the old config value (Except for
2598
# the "secret" attribute)
2599
if (name != "secret" and
2600
value != old_client_settings[client_name]
2601
[name]):
2602
client[name] = value
2603
except KeyError:
2604
pass
2605
2606
# Clients who has passed its expire date can still be
2607
# enabled if its last checker was successful. Clients
2608
# whose checker succeeded before we stored its state is
2609
# assumed to have successfully run all checkers during
2610
# downtime.
2611
if client["enabled"]:
2612
if datetime.datetime.utcnow() >= client["expires"]:
2613
if not client["last_checked_ok"]:
2614
logger.warning(
2615
"disabling client {0} - Client never "
2616
"performed a successful checker"
2617
.format(client_name))
2618
client["enabled"] = False
2619
elif client["last_checker_status"] != 0:
2620
logger.warning(
2621
"disabling client {0} - Client "
2622
"last checker failed with error code {1}"
2623
.format(client_name,
2624
client["last_checker_status"]))
2625
client["enabled"] = False
2626
else:
2627
client["expires"] = (datetime.datetime
2628
.utcnow()
2629
+ client["timeout"])
2630
logger.debug("Last checker succeeded,"
2631
" keeping {0} enabled"
2632
.format(client_name))
1777
def client_config_items(config, section):
1778
special_settings = {
1779
"approved_by_default":
1780
lambda: config.getboolean(section,
1781
"approved_by_default"),
1782
}
1783
for name, value in config.items(section):
2633
1784
try:
2634
client["secret"] = (
2635
pgp.decrypt(client["encrypted_secret"],
2636
client_settings[client_name]
2637
["secret"]))
2638
except PGPError:
2639
# If decryption fails, we use secret from new settings
2640
logger.debug("Failed to decrypt {0} old secret"
2641
.format(client_name))
2642
client["secret"] = (
2643
client_settings[client_name]["secret"])
2644
2645
# Add/remove clients based on new changes made to config
2646
for client_name in (set(old_client_settings)
2647
- set(client_settings)):
2648
del clients_data[client_name]
2649
for client_name in (set(client_settings)
2650
- set(old_client_settings)):
2651
clients_data[client_name] = client_settings[client_name]
2652
2653
# Create all client objects
2654
for client_name, client in clients_data.iteritems():
2655
tcp_server.clients[client_name] = client_class(
2656
name = client_name, settings = client,
2657
server_settings = server_settings)
2658
1785
yield (name, special_settings[name]())
1786
except KeyError:
1787
yield (name, value)
1788
1789
tcp_server.clients.update(set(
1790
client_class(name = section,
1791
config= dict(client_config_items(
1792
client_config, section)))
1793
for section in client_config.sections()))
2659
1794
if not tcp_server.clients:
2660
logger.warning("No clients defined")
2661
2662
if not foreground:
2663
if pidfile is not None:
2664
try:
2665
with pidfile:
2666
pid = os.getpid()
2667
pidfile.write(str(pid) + "\n".encode("utf-8"))
2668
except IOError:
2669
logger.error("Could not write to file %r with PID %d",
2670
pidfilename, pid)
1795
logger.warning(u"No clients defined")
1796
1797
if debug:
1798
# Redirect stdin so all checkers get /dev/null
1799
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1800
os.dup2(null, sys.stdin.fileno())
1801
if null > 2:
1802
os.close(null)
1803
else:
1804
# No console logging
1805
logger.removeHandler(console)
1806
# Close all input and output, do double fork, etc.
1807
daemon()
1808
1809
try:
1810
with pidfile:
1811
pid = os.getpid()
1812
pidfile.write(str(pid) + "\n")
2671
1813
del pidfile
2672
del pidfilename
1814
except IOError:
1815
logger.error(u"Could not write to file %r with PID %d",
1816
pidfilename, pid)
1817
except NameError:
1818
# "pidfile" was never created
1819
pass
1820
del pidfilename
2673
1821
1822
if not debug:
1823
signal.signal(signal.SIGINT, signal.SIG_IGN)
2674
1824
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2675
1825
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2676
1826
2677
1827
if use_dbus:
2678
@alternate_dbus_interfaces({"se.recompile.Mandos":
2679
"se.bsnet.fukt.Mandos"})
2680
class MandosDBusService(DBusObjectWithProperties):
1828
class MandosDBusService(dbus.service.Object):
2681
1829
"""A D-Bus proxy object"""
2682
1830
def __init__(self):
2683
dbus.service.Object.__init__(self, bus, "/")
2684
_interface = "se.recompile.Mandos"
2685
2686
@dbus_interface_annotations(_interface)
2687
def _foo(self):
2688
return { "org.freedesktop.DBus.Property"
2689
".EmitsChangedSignal":
2690
"false"}
2691
2692
@dbus.service.signal(_interface, signature="o")
1831
dbus.service.Object.__init__(self, bus, u"/")
1832
_interface = u"se.bsnet.fukt.Mandos"
1833
1834
@dbus.service.signal(_interface, signature=u"o")
2693
1835
def ClientAdded(self, objpath):
2694
1836
"D-Bus signal"
2695
1837
pass
2696
1838
2697
@dbus.service.signal(_interface, signature="ss")
1839
@dbus.service.signal(_interface, signature=u"ss")
2698
1840
def ClientNotFound(self, fingerprint, address):
2699
1841
"D-Bus signal"
2700
1842
pass
2701
1843
2702
@dbus.service.signal(_interface, signature="os")
1844
@dbus.service.signal(_interface, signature=u"os")
2703
1845
def ClientRemoved(self, objpath, name):
2704
1846
"D-Bus signal"
2705
1847
pass
2706
1848
2707
@dbus.service.method(_interface, out_signature="ao")
1849
@dbus.service.method(_interface, out_signature=u"ao")
2708
1850
def GetAllClients(self):
2709
1851
"D-Bus method"
2710
1852
return dbus.Array(c.dbus_object_path
2711
for c in
2712
tcp_server.clients.itervalues())
1853
for c in tcp_server.clients)
2713
1854
2714
1855
@dbus.service.method(_interface,
2715
out_signature="a{oa{sv}}")
1856
out_signature=u"a{oa{sv}}")
2716
1857
def GetAllClientsWithProperties(self):
2717
1858
"D-Bus method"
2718
1859
return dbus.Dictionary(
2719
((c.dbus_object_path, c.GetAll(""))
2720
for c in tcp_server.clients.itervalues()),
2721
signature="oa{sv}")
1860
((c.dbus_object_path, c.GetAll(u""))
1861
for c in tcp_server.clients),
1862
signature=u"oa{sv}")
2722
1863
2723
@dbus.service.method(_interface, in_signature="o")
1864
@dbus.service.method(_interface, in_signature=u"o")
2724
1865
def RemoveClient(self, object_path):
2725
1866
"D-Bus method"
2726
for c in tcp_server.clients.itervalues():
1867
for c in tcp_server.clients:
2727
1868
if c.dbus_object_path == object_path:
2728
del tcp_server.clients[c.name]
1869
tcp_server.clients.remove(c)
2729
1870
c.remove_from_connection()
2730
1871
# Don't signal anything except ClientRemoved
2731
1872
c.disable(quiet=True)
2742
1883
"Cleanup function; run on exit"
2743
1884
service.cleanup()
2744
1885
2745
multiprocessing.active_children()
2746
wnull.close()
2747
if not (tcp_server.clients or client_settings):
2748
return
2749
2750
# Store client before exiting. Secrets are encrypted with key
2751
# based on what config file has. If config file is
2752
# removed/edited, old secret will thus be unrecovable.
2753
clients = {}
2754
with PGPEngine() as pgp:
2755
for client in tcp_server.clients.itervalues():
2756
key = client_settings[client.name]["secret"]
2757
client.encrypted_secret = pgp.encrypt(client.secret,
2758
key)
2759
client_dict = {}
2760
2761
# A list of attributes that can not be pickled
2762
# + secret.
2763
exclude = set(("bus", "changedstate", "secret",
2764
"checker", "server_settings"))
2765
for name, typ in (inspect.getmembers
2766
(dbus.service.Object)):
2767
exclude.add(name)
2768
2769
client_dict["encrypted_secret"] = (client
2770
.encrypted_secret)
2771
for attr in client.client_structure:
2772
if attr not in exclude:
2773
client_dict[attr] = getattr(client, attr)
2774
2775
clients[client.name] = client_dict
2776
del client_settings[client.name]["secret"]
2777
2778
try:
2779
with (tempfile.NamedTemporaryFile
2780
(mode='wb', suffix=".pickle", prefix='clients-',
2781
dir=os.path.dirname(stored_state_path),
2782
delete=False)) as stored_state:
2783
pickle.dump((clients, client_settings), stored_state)
2784
tempname=stored_state.name
2785
os.rename(tempname, stored_state_path)
2786
except (IOError, OSError) as e:
2787
if not debug:
2788
try:
2789
os.remove(tempname)
2790
except NameError:
2791
pass
2792
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2793
logger.warning("Could not save persistent state: {0}"
2794
.format(os.strerror(e.errno)))
2795
else:
2796
logger.warning("Could not save persistent state:",
2797
exc_info=e)
2798
raise
2799
2800
# Delete all clients, and settings from config
2801
1886
while tcp_server.clients:
2802
name, client = tcp_server.clients.popitem()
1887
client = tcp_server.clients.pop()
2803
1888
if use_dbus:
2804
1889
client.remove_from_connection()
1890
client.disable_hook = None
2805
1891
# Don't signal anything except ClientRemoved
2806
1892
client.disable(quiet=True)
2807
1893
if use_dbus:
2808
1894
# Emit D-Bus signal
2809
mandos_dbus_service.ClientRemoved(client
2810
.dbus_object_path,
1895
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2811
1896
client.name)
2812
client_settings.clear()
2813
1897
2814
1898
atexit.register(cleanup)
2815
1899
2816
for client in tcp_server.clients.itervalues():
1900
for client in tcp_server.clients:
2817
1901
if use_dbus:
2818
1902
# Emit D-Bus signal
2819
1903
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2820
# Need to initiate checking of clients
2821
if client.enabled:
2822
client.init_checker()
1904
client.enable()
2823
1905
2824
1906
tcp_server.enable()
2825
1907
tcp_server.server_activate()
2827
1909
# Find out what port we got
2828
1910
service.port = tcp_server.socket.getsockname()[1]
2829
1911
if use_ipv6:
2830
logger.info("Now listening on address %r, port %d,"
2831
" flowinfo %d, scope_id %d",
2832
*tcp_server.socket.getsockname())
1912
logger.info(u"Now listening on address %r, port %d,"
1913
" flowinfo %d, scope_id %d"
1914
% tcp_server.socket.getsockname())
2833
1915
else: # IPv4
2834
logger.info("Now listening on address %r, port %d",
2835
*tcp_server.socket.getsockname())
1916
logger.info(u"Now listening on address %r, port %d"
1917
% tcp_server.socket.getsockname())
2836
1918
2837
1919
#service.interface = tcp_server.socket.getsockname()[3]
2838
1920
2840
1922
# From the Avahi example code
2841
1923
try:
2842
1924
service.activate()
2843
except dbus.exceptions.DBusException as error:
2844
logger.critical("D-Bus Exception", exc_info=error)
1925
except dbus.exceptions.DBusException, error:
1926
logger.critical(u"DBusException: %s", error)
2845
1927
cleanup()
2846
1928
sys.exit(1)
2847
1929
# End of Avahi example code
2851
1933
(tcp_server.handle_request
2852
1934
(*args[2:], **kwargs) or True))
2853
1935
2854
logger.debug("Starting main loop")
1936
logger.debug(u"Starting main loop")
2855
1937
main_loop.run()
2856
except AvahiError as error:
2857
logger.critical("Avahi Error", exc_info=error)
1938
except AvahiError, error:
1939
logger.critical(u"AvahiError: %s", error)
2858
1940
cleanup()
2859
1941
sys.exit(1)
2860
1942
except KeyboardInterrupt:
2861
1943
if debug:
2862
print("", file=sys.stderr)
2863
logger.debug("Server received KeyboardInterrupt")
2864
logger.debug("Server exiting")
1944
print >> sys.stderr
1945
logger.debug(u"Server received KeyboardInterrupt")
1946
logger.debug(u"Server exiting")
2865
1947
# Must run before the D-Bus bus name gets deregistered
2866
1948
cleanup()
2867
1949
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0