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