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