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