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