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