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