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