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 427
- compare with another revision
- download diff
- download tarball
- view history from revision 427
- Committer: Teddy Hogeborn
- Date: 2010-09-13 05:56:48 UTC
- mfrom: (420.1.1 mandos-local)
- Revision ID: teddy@fukt.bsnet.se-20100913055648-v92t4egg6xubyqqo
Merge Makefile change.
- files removed:
- debian/mandos-client.examples
- debian/source
- debian/upstream
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
1
#!/usr/bin/python2.7
1
#!/usr/bin/python
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-2015 Teddy Hogeborn
15
# Copyright © 2008-2015 Björn Påhlsson
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 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@recompile.se>.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
#
33
33
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
34
from __future__ import division, with_statement, absolute_import
38
35
39
36
import SocketServer as socketserver
40
37
import socket
41
import argparse
38
import optparse
42
39
import datetime
43
40
import errno
44
41
import gnutls.crypto
64
61
import functools
65
62
import cPickle as pickle
66
63
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
72
64
73
65
import dbus
74
66
import dbus.service
88
80
except ImportError:
89
81
SO_BINDTODEVICE = None
90
82
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
83
84
version = "1.0.14"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
223
101
224
102
class AvahiError(Exception):
225
103
def __init__(self, value, *args, **kwargs):
226
104
self.value = value
227
return super(AvahiError, self).__init__(value, *args,
228
**kwargs)
229
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
230
108
231
109
class AvahiServiceError(AvahiError):
232
110
pass
233
111
234
235
112
class AvahiGroupError(AvahiError):
236
113
pass
237
114
242
119
Attributes:
243
120
interface: integer; avahi.IF_UNSPEC or an interface index.
244
121
Used to optionally bind to the specified interface.
245
name: string; Example: 'Mandos'
246
type: string; Example: '_mandos._tcp'.
247
See <https://www.iana.org/assignments/service-names-port-numbers>
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
248
125
port: integer; what port to announce
249
126
TXT: list of strings; TXT record for the service
250
127
domain: string; Domain to publish on, default to .local if empty.
256
133
server: D-Bus Server
257
134
bus: dbus.SystemBus()
258
135
"""
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):
136
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
137
servicetype = None, port = None, TXT = None,
138
domain = u"", host = u"", max_renames = 32768,
139
protocol = avahi.PROTO_UNSPEC, bus = None):
271
140
self.interface = interface
272
141
self.name = name
273
142
self.type = servicetype
281
150
self.group = None # our entry group
282
151
self.server = None
283
152
self.bus = bus
284
self.entry_group_state_changed_match = None
285
286
def rename(self, remove=True):
153
def rename(self):
287
154
"""Derived from the Avahi example code"""
288
155
if self.rename_count >= self.max_renames:
289
logger.critical("No suitable Zeroconf service name found"
290
" after %i retries, exiting.",
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
291
158
self.rename_count)
292
raise AvahiServiceError("Too many renames")
293
self.name = str(
294
self.server.GetAlternativeServiceName(self.name))
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
162
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
167
self.remove()
168
try:
169
self.add()
170
except dbus.exceptions.DBusException, error:
171
logger.critical(u"DBusException: %s", error)
172
self.cleanup()
173
os._exit(1)
295
174
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
312
175
def remove(self):
313
176
"""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
317
177
if self.group is not None:
318
178
self.group.Reset()
319
320
179
def add(self):
321
180
"""Derived from the Avahi example code"""
322
self.remove()
323
181
if self.group is None:
324
182
self.group = dbus.Interface(
325
183
self.bus.get_object(avahi.DBUS_NAME,
326
184
self.server.EntryGroupNew()),
327
185
avahi.DBUS_INTERFACE_ENTRY_GROUP)
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' ...",
186
self.group.connect_to_signal('StateChanged',
187
self
188
.entry_group_state_changed)
189
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
332
190
self.name, self.type)
333
191
self.group.AddService(
334
192
self.interface,
339
197
dbus.UInt16(self.port),
340
198
avahi.string_array_to_txt_array(self.TXT))
341
199
self.group.Commit()
342
343
200
def entry_group_state_changed(self, state, error):
344
201
"""Derived from the Avahi example code"""
345
logger.debug("Avahi entry group state change: %i", state)
202
logger.debug(u"Avahi entry group state change: %i", state)
346
203
347
204
if state == avahi.ENTRY_GROUP_ESTABLISHED:
348
logger.debug("Zeroconf service established.")
205
logger.debug(u"Zeroconf service established.")
349
206
elif state == avahi.ENTRY_GROUP_COLLISION:
350
logger.info("Zeroconf service name collision.")
207
logger.warning(u"Zeroconf service name collision.")
351
208
self.rename()
352
209
elif state == avahi.ENTRY_GROUP_FAILURE:
353
logger.critical("Avahi: Error in group state changed %s",
354
str(error))
355
raise AvahiGroupError("State changed: {!s}".format(error))
356
210
logger.critical(u"Avahi: Error in group state changed %s",
211
unicode(error))
212
raise AvahiGroupError(u"State changed: %s"
213
% unicode(error))
357
214
def cleanup(self):
358
215
"""Derived from the Avahi example code"""
359
216
if self.group is not None:
360
try:
361
self.group.Free()
362
except (dbus.exceptions.UnknownMethodException,
363
dbus.exceptions.DBusException):
364
pass
217
self.group.Free()
365
218
self.group = None
366
self.remove()
367
368
def server_state_changed(self, state, error=None):
219
def server_state_changed(self, state):
369
220
"""Derived from the Avahi example code"""
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()
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
224
self.remove()
384
225
elif state == avahi.SERVER_RUNNING:
385
226
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
392
227
def activate(self):
393
228
"""Derived from the Avahi example code"""
394
229
if self.server is None:
395
230
self.server = dbus.Interface(
396
231
self.bus.get_object(avahi.DBUS_NAME,
397
avahi.DBUS_PATH_SERVER,
398
follow_name_owner_changes=True),
232
avahi.DBUS_PATH_SERVER),
399
233
avahi.DBUS_INTERFACE_SERVER)
400
self.server.connect_to_signal("StateChanged",
401
self.server_state_changed)
234
self.server.connect_to_signal(u"StateChanged",
235
self.server_state_changed)
402
236
self.server_state_changed(self.server.GetState())
403
237
404
238
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
415
239
class Client(object):
416
240
"""A representation of a client host served by this server.
417
241
418
242
Attributes:
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
243
name: string; from the config file, used in log messages and
244
D-Bus identifiers
245
fingerprint: string (40 or 32 hexadecimal digits); used to
246
uniquely identify the client
247
secret: bytestring; sent verbatim (over TLS) to client
248
host: string; available for use by the checker command
249
created: datetime.datetime(); (UTC) object creation
250
last_enabled: datetime.datetime(); (UTC)
251
enabled: bool()
252
last_checked_ok: datetime.datetime(); (UTC) or None
253
timeout: datetime.timedelta(); How long from last_checked_ok
254
until this client is disabled
255
interval: datetime.timedelta(); How often to start a new checker
256
disable_hook: If set, called by disable() as disable_hook(self)
422
257
checker: subprocess.Popen(); a running checker process used
423
258
to see if the client lives.
424
259
'None' if no process is running.
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
260
checker_initiator_tag: a gobject event source tag, or None
261
disable_initiator_tag: - '' -
262
checker_callback_tag: - '' -
263
checker_command: string; External command which is run to check if
264
client lives. %() expansions are done at
428
265
runtime with vars(self) as dict, so that for
429
266
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
434
267
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()
268
approval_delay: datetime.timedelta(); Time to wait for approval
269
_approved: bool(); 'None' if not yet approved/disapproved
270
approval_duration: datetime.timedelta(); Duration of one approval
457
271
"""
458
272
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
476
273
@staticmethod
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):
274
def _timedelta_to_milliseconds(td):
275
"Convert a datetime.timedelta() to milliseconds"
276
return ((td.days * 24 * 60 * 60 * 1000)
277
+ (td.seconds * 1000)
278
+ (td.microseconds // 1000))
279
280
def timeout_milliseconds(self):
281
"Return the 'timeout' attribute in milliseconds"
282
return self._timedelta_to_milliseconds(self.timeout)
283
284
def interval_milliseconds(self):
285
"Return the 'interval' attribute in milliseconds"
286
return self._timedelta_to_milliseconds(self.interval)
287
288
def approval_delay_milliseconds(self):
289
return self._timedelta_to_milliseconds(self.approval_delay)
290
291
def __init__(self, name = None, disable_hook=None, config=None):
292
"""Note: the 'checker' key in 'config' sets the
293
'checker_command' attribute and *not* the 'checker'
294
attribute."""
527
295
self.name = name
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)
296
if config is None:
297
config = {}
298
logger.debug(u"Creating client %r", self.name)
299
# Uppercase and remove spaces from fingerprint for later
300
# comparison purposes with return value from the fingerprint()
301
# function
302
self.fingerprint = (config[u"fingerprint"].upper()
303
.replace(u" ", u""))
304
logger.debug(u" Fingerprint: %s", self.fingerprint)
305
if u"secret" in config:
306
self.secret = config[u"secret"].decode(u"base64")
307
elif u"secfile" in config:
308
with open(os.path.expanduser(os.path.expandvars
309
(config[u"secfile"])),
310
"rb") as secfile:
311
self.secret = secfile.read()
541
312
else:
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
313
raise TypeError(u"No secret or secfile for client %s"
314
% self.name)
315
self.host = config.get(u"host", u"")
316
self.created = datetime.datetime.utcnow()
317
self.enabled = False
318
self.last_enabled = None
319
self.last_checked_ok = None
320
self.timeout = string_to_delta(config[u"timeout"])
321
self.interval = string_to_delta(config[u"interval"])
322
self.disable_hook = disable_hook
551
323
self.checker = None
552
324
self.checker_initiator_tag = None
553
325
self.disable_initiator_tag = None
554
326
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
555
328
self.current_checker_command = None
556
self.approved = None
329
self.last_connect = None
330
self._approved = None
331
self.approved_by_default = config.get(u"approved_by_default",
332
True)
557
333
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)
334
self.approval_delay = string_to_delta(
335
config[u"approval_delay"])
336
self.approval_duration = string_to_delta(
337
config[u"approval_duration"])
338
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
569
339
570
# Send notice to process children that client state has changed
571
340
def send_changedstate(self):
572
with self.changedstate:
573
self.changedstate.notify_all()
574
341
self.changedstate.acquire()
342
self.changedstate.notify_all()
343
self.changedstate.release()
344
575
345
def enable(self):
576
346
"""Start this client's checker and timeout hooks"""
577
if getattr(self, "enabled", False):
347
if getattr(self, u"enabled", False):
578
348
# Already enabled
579
349
return
580
self.expires = datetime.datetime.utcnow() + self.timeout
581
self.enabled = True
350
self.send_changedstate()
582
351
self.last_enabled = datetime.datetime.utcnow()
583
self.init_checker()
584
self.send_changedstate()
352
# Schedule a new checker to be started an 'interval' from now,
353
# and every interval from then on.
354
self.checker_initiator_tag = (gobject.timeout_add
355
(self.interval_milliseconds(),
356
self.start_checker))
357
# Schedule a disable() when 'timeout' has passed
358
self.disable_initiator_tag = (gobject.timeout_add
359
(self.timeout_milliseconds(),
360
self.disable))
361
self.enabled = True
362
# Also start a new checker *right now*.
363
self.start_checker()
585
364
586
365
def disable(self, quiet=True):
587
366
"""Disable this client."""
588
367
if not getattr(self, "enabled", False):
589
368
return False
590
369
if not quiet:
591
logger.info("Disabling client %s", self.name)
592
if getattr(self, "disable_initiator_tag", None) is not None:
370
self.send_changedstate()
371
if not quiet:
372
logger.info(u"Disabling client %s", self.name)
373
if getattr(self, u"disable_initiator_tag", False):
593
374
gobject.source_remove(self.disable_initiator_tag)
594
375
self.disable_initiator_tag = None
595
self.expires = None
596
if getattr(self, "checker_initiator_tag", None) is not None:
376
if getattr(self, u"checker_initiator_tag", False):
597
377
gobject.source_remove(self.checker_initiator_tag)
598
378
self.checker_initiator_tag = None
599
379
self.stop_checker()
380
if self.disable_hook:
381
self.disable_hook(self)
600
382
self.enabled = False
601
if not quiet:
602
self.send_changedstate()
603
383
# Do not run this again if called by a gobject.timeout_add
604
384
return False
605
385
606
386
def __del__(self):
387
self.disable_hook = None
607
388
self.disable()
608
389
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
625
390
def checker_callback(self, pid, condition, command):
626
391
"""The checker has completed, so take appropriate actions."""
627
392
self.checker_callback_tag = None
628
393
self.checker = None
629
394
if os.WIFEXITED(condition):
630
self.last_checker_status = os.WEXITSTATUS(condition)
631
if self.last_checker_status == 0:
632
logger.info("Checker for %(name)s succeeded",
395
exitstatus = os.WEXITSTATUS(condition)
396
if exitstatus == 0:
397
logger.info(u"Checker for %(name)s succeeded",
633
398
vars(self))
634
399
self.checked_ok()
635
400
else:
636
logger.info("Checker for %(name)s failed", vars(self))
401
logger.info(u"Checker for %(name)s failed",
402
vars(self))
637
403
else:
638
self.last_checker_status = -1
639
logger.warning("Checker for %(name)s crashed?",
404
logger.warning(u"Checker for %(name)s crashed?",
640
405
vars(self))
641
406
642
407
def checked_ok(self):
643
"""Assert that the client has been seen, alive and well."""
408
"""Bump up the timeout for this client.
409
410
This should only be called when the client has been seen,
411
alive and well.
412
"""
644
413
self.last_checked_ok = datetime.datetime.utcnow()
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()
414
gobject.source_remove(self.disable_initiator_tag)
415
self.disable_initiator_tag = (gobject.timeout_add
416
(self.timeout_milliseconds(),
417
self.disable))
662
418
663
419
def start_checker(self):
664
420
"""Start a new checker subprocess if one is not running.
666
422
If a checker already exists, leave it running and do
667
423
nothing."""
668
424
# The reason for not killing a running checker is that if we
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
425
# did that, then if a checker (for some reason) started
426
# running slowly and taking more than 'interval' time, the
427
# client would inevitably timeout, since no checker would get
428
# a chance to run to completion. If we instead leave running
673
429
# checkers alone, the checker would have to take more time
674
430
# than 'timeout' for the client to be disabled, which is as it
675
431
# should be.
677
433
# If a checker exists, make sure it is not a zombie
678
434
try:
679
435
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
436
except (AttributeError, OSError), error:
437
if (isinstance(error, OSError)
438
and error.errno != errno.ECHILD):
439
raise error
685
440
else:
686
441
if pid:
687
logger.warning("Checker was a zombie")
442
logger.warning(u"Checker was a zombie")
688
443
gobject.source_remove(self.checker_callback_tag)
689
444
self.checker_callback(pid, status,
690
445
self.current_checker_command)
691
446
# Start a new checker if needed
692
447
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 }
697
448
try:
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
449
# In case checker_command has exactly one % operator
450
command = self.checker_command % self.host
451
except TypeError:
452
# Escape attributes for the shell
453
escaped_attrs = dict((key,
454
re.escape(unicode(str(val),
455
errors=
456
u'replace')))
457
for key, val in
458
vars(self).iteritems())
459
try:
460
command = self.checker_command % escaped_attrs
461
except TypeError, error:
462
logger.error(u'Could not format string "%s":'
463
u' %s', self.checker_command, error)
464
return True # Try again later
704
465
self.current_checker_command = command
705
466
try:
706
logger.info("Starting checker %r for %s", command,
707
self.name)
467
logger.info(u"Starting checker %r for %s",
468
command, self.name)
708
469
# We don't need to redirect stdout and stderr, since
709
470
# in normal mode, that is already done by daemon(),
710
471
# and in debug mode we don't want to. (Stdin is
711
472
# 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 })
720
473
self.checker = subprocess.Popen(command,
721
474
close_fds=True,
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:
475
shell=True, cwd=u"/")
476
self.checker_callback_tag = (gobject.child_watch_add
477
(self.checker.pid,
478
self.checker_callback,
479
data=command))
480
# The checker may have completed before the gobject
481
# watch was added. Check for this.
734
482
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
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)
483
if pid:
484
gobject.source_remove(self.checker_callback_tag)
485
self.checker_callback(pid, status, command)
486
except OSError, error:
487
logger.error(u"Failed to start subprocess: %s",
488
error)
745
489
# Re-run this periodically if run by gobject.timeout_add
746
490
return True
747
491
750
494
if self.checker_callback_tag:
751
495
gobject.source_remove(self.checker_callback_tag)
752
496
self.checker_callback_tag = None
753
if getattr(self, "checker", None) is None:
497
if getattr(self, u"checker", None) is None:
754
498
return
755
logger.debug("Stopping checker for %(name)s", vars(self))
499
logger.debug(u"Stopping checker for %(name)s", vars(self))
756
500
try:
757
self.checker.terminate()
501
os.kill(self.checker.pid, signal.SIGTERM)
758
502
#time.sleep(0.5)
759
503
#if self.checker.poll() is None:
760
# self.checker.kill()
761
except OSError as error:
504
# os.kill(self.checker.pid, signal.SIGKILL)
505
except OSError, error:
762
506
if error.errno != errno.ESRCH: # No such process
763
507
raise
764
508
self.checker = None
765
509
766
767
def dbus_service_property(dbus_interface,
768
signature="v",
769
access="readwrite",
770
byte_arrays=False):
510
def dbus_service_property(dbus_interface, signature=u"v",
511
access=u"readwrite", byte_arrays=False):
771
512
"""Decorators for marking methods of a DBusObjectWithProperties to
772
513
become properties on the D-Bus.
773
514
780
521
"""
781
522
# Encoding deeply encoded byte arrays is not supported yet by the
782
523
# "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
524
if byte_arrays and signature != u"ay":
525
raise ValueError(u"Byte arrays not supported for non-'ay'"
526
u" signature %r" % signature)
787
527
def decorator(func):
788
528
func._dbus_is_property = True
789
529
func._dbus_interface = dbus_interface
790
530
func._dbus_signature = signature
791
531
func._dbus_access = access
792
532
func._dbus_name = func.__name__
793
if func._dbus_name.endswith("_dbus_property"):
533
if func._dbus_name.endswith(u"_dbus_property"):
794
534
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
535
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
536
return func
839
537
return decorator
840
538
841
539
842
540
class DBusPropertyException(dbus.exceptions.DBusException):
843
541
"""A base class for D-Bus property-related exceptions
844
542
"""
845
pass
543
def __unicode__(self):
544
return unicode(str(self))
846
545
847
546
848
547
class DBusPropertyAccessException(DBusPropertyException):
859
558
860
559
class DBusObjectWithProperties(dbus.service.Object):
861
560
"""A D-Bus object with properties.
862
561
863
562
Classes inheriting from this can use the dbus_service_property
864
563
decorator to expose methods as D-Bus properties. It exposes the
865
564
standard Get(), Set(), and GetAll() methods on the D-Bus.
866
565
"""
867
566
868
567
@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)
568
def _is_dbus_property(obj):
569
return getattr(obj, u"_dbus_is_property", False)
877
570
878
def _get_all_dbus_things(self, thing):
571
def _get_all_dbus_properties(self):
879
572
"""Returns a generator of (name, attribute) pairs
880
573
"""
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)))
574
return ((prop._dbus_name, prop)
575
for name, prop in
576
inspect.getmembers(self, self._is_dbus_property))
886
577
887
578
def _get_dbus_property(self, interface_name, property_name):
888
579
"""Returns a bound method if one exists which is a D-Bus
889
580
property with the specified name and interface.
890
581
"""
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
582
for name in (property_name,
583
property_name + u"_dbus_property"):
584
prop = getattr(self, name, None)
585
if (prop is None
586
or not self._is_dbus_property(prop)
587
or prop._dbus_name != property_name
588
or (interface_name and prop._dbus_interface
589
and interface_name != prop._dbus_interface)):
590
continue
591
return prop
898
592
# No such property
899
raise DBusPropertyNotFound("{}:{}.{}".format(
900
self.dbus_object_path, interface_name, property_name))
593
raise DBusPropertyNotFound(self.dbus_object_path + u":"
594
+ interface_name + u"."
595
+ property_name)
901
596
902
@dbus.service.method(dbus.PROPERTIES_IFACE,
903
in_signature="ss",
904
out_signature="v")
597
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
598
out_signature=u"v")
905
599
def Get(self, interface_name, property_name):
906
600
"""Standard D-Bus property Get() method, see D-Bus standard.
907
601
"""
908
602
prop = self._get_dbus_property(interface_name, property_name)
909
if prop._dbus_access == "write":
603
if prop._dbus_access == u"write":
910
604
raise DBusPropertyAccessException(property_name)
911
605
value = prop()
912
if not hasattr(value, "variant_level"):
606
if not hasattr(value, u"variant_level"):
913
607
return value
914
608
return type(value)(value, variant_level=value.variant_level+1)
915
609
916
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
917
611
def Set(self, interface_name, property_name, value):
918
612
"""Standard D-Bus property Set() method, see D-Bus standard.
919
613
"""
920
614
prop = self._get_dbus_property(interface_name, property_name)
921
if prop._dbus_access == "read":
615
if prop._dbus_access == u"read":
922
616
raise DBusPropertyAccessException(property_name)
923
if prop._dbus_get_args_options["byte_arrays"]:
617
if prop._dbus_get_args_options[u"byte_arrays"]:
924
618
# The byte_arrays option is not supported yet on
925
619
# 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))
620
if prop._dbus_signature != u"ay":
621
raise ValueError
622
value = dbus.ByteArray(''.join(unichr(byte)
623
for byte in value))
932
624
prop(value)
933
625
934
@dbus.service.method(dbus.PROPERTIES_IFACE,
935
in_signature="s",
936
out_signature="a{sv}")
626
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
627
out_signature=u"a{sv}")
937
628
def GetAll(self, interface_name):
938
629
"""Standard D-Bus property GetAll() method, see D-Bus
939
630
standard.
940
631
941
632
Note: Will not include properties with access="write".
942
633
"""
943
properties = {}
944
for name, prop in self._get_all_dbus_things("property"):
634
all = {}
635
for name, prop in self._get_all_dbus_properties():
945
636
if (interface_name
946
637
and interface_name != prop._dbus_interface):
947
638
# Interface non-empty but did not match
948
639
continue
949
640
# Ignore write-only properties
950
if prop._dbus_access == "write":
641
if prop._dbus_access == u"write":
951
642
continue
952
643
value = prop()
953
if not hasattr(value, "variant_level"):
954
properties[name] = value
644
if not hasattr(value, u"variant_level"):
645
all[name] = value
955
646
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
647
all[name] = type(value)(value, variant_level=
648
value.variant_level+1)
649
return dbus.Dictionary(all, signature=u"sv")
967
650
968
651
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
969
out_signature="s",
652
out_signature=u"s",
970
653
path_keyword='object_path',
971
654
connection_keyword='connection')
972
655
def Introspect(self, object_path, connection):
973
"""Overloading of standard D-Bus method.
974
975
Inserts property tags and interface annotation tags.
656
"""Standard D-Bus method, overloaded to insert property tags.
976
657
"""
977
658
xmlstring = dbus.service.Object.Introspect(self, object_path,
978
659
connection)
979
660
try:
980
661
document = xml.dom.minidom.parseString(xmlstring)
981
982
662
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)
663
e = document.createElement(u"property")
664
e.setAttribute(u"name", name)
665
e.setAttribute(u"type", prop._dbus_signature)
666
e.setAttribute(u"access", prop._dbus_access)
987
667
return e
988
989
for if_tag in document.getElementsByTagName("interface"):
990
# Add property tags
668
for if_tag in document.getElementsByTagName(u"interface"):
991
669
for tag in (make_tag(document, name, prop)
992
670
for name, prop
993
in self._get_all_dbus_things("property")
671
in self._get_all_dbus_properties()
994
672
if prop._dbus_interface
995
== if_tag.getAttribute("name")):
673
== if_tag.getAttribute(u"name")):
996
674
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
675
# Add the names to the return values for the
1027
676
# "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")
677
if (if_tag.getAttribute(u"name")
678
== u"org.freedesktop.DBus.Properties"):
679
for cn in if_tag.getElementsByTagName(u"method"):
680
if cn.getAttribute(u"name") == u"Get":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
683
== u"out"):
684
arg.setAttribute(u"name", u"value")
685
elif cn.getAttribute(u"name") == u"GetAll":
686
for arg in cn.getElementsByTagName(u"arg"):
687
if (arg.getAttribute(u"direction")
688
== u"out"):
689
arg.setAttribute(u"name", u"props")
690
xmlstring = document.toxml(u"utf-8")
1042
691
document.unlink()
1043
692
except (AttributeError, xml.dom.DOMException,
1044
xml.parsers.expat.ExpatError) as error:
1045
logger.error("Failed to override Introspection method",
1046
exc_info=error)
693
xml.parsers.expat.ExpatError), error:
694
logger.error(u"Failed to override Introspection method",
695
error)
1047
696
return xmlstring
1048
697
1049
698
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
699
class ClientDBus(Client, DBusObjectWithProperties):
1229
700
"""A Client class using D-Bus
1230
701
1232
703
dbus_object_path: dbus.ObjectPath
1233
704
bus: dbus.SystemBus()
1234
705
"""
1235
1236
runtime_expansions = (Client.runtime_expansions
1237
+ ("dbus_object_path", ))
1238
1239
_interface = "se.recompile.Mandos.Client"
1240
1241
706
# dbus.service.Object doesn't use super(), so we can't either.
1242
707
1243
708
def __init__(self, bus = None, *args, **kwargs):
709
self._approvals_pending = 0
1244
710
self.bus = bus
1245
711
Client.__init__(self, *args, **kwargs)
1246
712
# Only now, when this client is initialized, can it show up on
1247
713
# the D-Bus
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)
714
self.dbus_object_path = (dbus.ObjectPath
715
(u"/clients/"
716
+ self.name.replace(u".", u"_")))
1253
717
DBusObjectWithProperties.__init__(self, self.bus,
1254
718
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
719
720
def _get_approvals_pending(self):
721
return self._approvals_pending
722
def _set_approvals_pending(self, value):
723
old_value = self._approvals_pending
724
self._approvals_pending = value
725
bval = bool(value)
726
if (hasattr(self, "dbus_object_path")
727
and bval is not bool(old_value)):
728
dbus_bool = dbus.Boolean(bval, variant_level=1)
729
self.PropertyChanged(dbus.String(u"ApprovalPending"),
730
dbus_bool)
731
732
approvals_pending = property(_get_approvals_pending,
733
_set_approvals_pending)
734
del _get_approvals_pending, _set_approvals_pending
735
736
@staticmethod
737
def _datetime_to_dbus(dt, variant_level=0):
738
"""Convert a UTC datetime.datetime() to a D-Bus type."""
739
return dbus.String(dt.isoformat(),
740
variant_level=variant_level)
741
742
def enable(self):
743
oldstate = getattr(self, u"enabled", False)
744
r = Client.enable(self)
745
if oldstate != self.enabled:
746
# Emit D-Bus signals
747
self.PropertyChanged(dbus.String(u"Enabled"),
748
dbus.Boolean(True, variant_level=1))
749
self.PropertyChanged(
750
dbus.String(u"LastEnabled"),
751
self._datetime_to_dbus(self.last_enabled,
752
variant_level=1))
753
return r
754
755
def disable(self, quiet = False):
756
oldstate = getattr(self, u"enabled", False)
757
r = Client.disable(self, quiet=quiet)
758
if not quiet and oldstate != self.enabled:
759
# Emit D-Bus signal
760
self.PropertyChanged(dbus.String(u"Enabled"),
761
dbus.Boolean(False, variant_level=1))
762
return r
1336
763
1337
764
def __del__(self, *args, **kwargs):
1338
765
try:
1339
766
self.remove_from_connection()
1340
767
except LookupError:
1341
768
pass
1342
if hasattr(DBusObjectWithProperties, "__del__"):
769
if hasattr(DBusObjectWithProperties, u"__del__"):
1343
770
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1344
771
Client.__del__(self, *args, **kwargs)
1345
772
1347
774
*args, **kwargs):
1348
775
self.checker_callback_tag = None
1349
776
self.checker = None
777
# Emit D-Bus signal
778
self.PropertyChanged(dbus.String(u"CheckerRunning"),
779
dbus.Boolean(False, variant_level=1))
1350
780
if os.WIFEXITED(condition):
1351
781
exitstatus = os.WEXITSTATUS(condition)
1352
782
# Emit D-Bus signal
1362
792
return Client.checker_callback(self, pid, condition, command,
1363
793
*args, **kwargs)
1364
794
795
def checked_ok(self, *args, **kwargs):
796
r = Client.checked_ok(self, *args, **kwargs)
797
# Emit D-Bus signal
798
self.PropertyChanged(
799
dbus.String(u"LastCheckedOK"),
800
(self._datetime_to_dbus(self.last_checked_ok,
801
variant_level=1)))
802
return r
803
1365
804
def start_checker(self, *args, **kwargs):
1366
old_checker_pid = getattr(self.checker, "pid", None)
805
old_checker = self.checker
806
if self.checker is not None:
807
old_checker_pid = self.checker.pid
808
else:
809
old_checker_pid = None
1367
810
r = Client.start_checker(self, *args, **kwargs)
1368
811
# Only if new checker process was started
1369
812
if (self.checker is not None
1370
813
and old_checker_pid != self.checker.pid):
1371
814
# Emit D-Bus signal
1372
815
self.CheckerStarted(self.current_checker_command)
816
self.PropertyChanged(
817
dbus.String(u"CheckerRunning"),
818
dbus.Boolean(True, variant_level=1))
1373
819
return r
1374
820
821
def stop_checker(self, *args, **kwargs):
822
old_checker = getattr(self, u"checker", None)
823
r = Client.stop_checker(self, *args, **kwargs)
824
if (old_checker is not None
825
and getattr(self, u"checker", None) is None):
826
self.PropertyChanged(dbus.String(u"CheckerRunning"),
827
dbus.Boolean(False, variant_level=1))
828
return r
829
1375
830
def _reset_approved(self):
1376
self.approved = None
831
self._approved = None
1377
832
return False
1378
833
1379
834
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
835
self.send_changedstate()
836
self._approved = value
837
gobject.timeout_add(self._timedelta_to_milliseconds
838
(self.approval_duration),
839
self._reset_approved)
840
1384
841
1385
842
## D-Bus methods, signals & properties
1386
1387
## Interfaces
843
_interface = u"se.bsnet.fukt.Mandos.Client"
1388
844
1389
845
## Signals
1390
846
1391
847
# CheckerCompleted - signal
1392
@dbus.service.signal(_interface, signature="nxs")
848
@dbus.service.signal(_interface, signature=u"nxs")
1393
849
def CheckerCompleted(self, exitcode, waitstatus, command):
1394
850
"D-Bus signal"
1395
851
pass
1396
852
1397
853
# CheckerStarted - signal
1398
@dbus.service.signal(_interface, signature="s")
854
@dbus.service.signal(_interface, signature=u"s")
1399
855
def CheckerStarted(self, command):
1400
856
"D-Bus signal"
1401
857
pass
1402
858
1403
859
# PropertyChanged - signal
1404
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1405
@dbus.service.signal(_interface, signature="sv")
860
@dbus.service.signal(_interface, signature=u"sv")
1406
861
def PropertyChanged(self, property, value):
1407
862
"D-Bus signal"
1408
863
pass
1417
872
pass
1418
873
1419
874
# Rejected - signal
1420
@dbus.service.signal(_interface, signature="s")
875
@dbus.service.signal(_interface, signature=u"s")
1421
876
def Rejected(self, reason):
1422
877
"D-Bus signal"
1423
878
pass
1424
879
1425
880
# NeedApproval - signal
1426
@dbus.service.signal(_interface, signature="tb")
881
@dbus.service.signal(_interface, signature=u"tb")
1427
882
def NeedApproval(self, timeout, default):
1428
883
"D-Bus signal"
1429
return self.need_approval()
884
pass
1430
885
1431
886
## Methods
1432
887
1433
888
# Approve - method
1434
@dbus.service.method(_interface, in_signature="b")
889
@dbus.service.method(_interface, in_signature=u"b")
1435
890
def Approve(self, value):
1436
891
self.approve(value)
1437
892
1438
893
# CheckedOK - method
1439
894
@dbus.service.method(_interface)
1440
895
def CheckedOK(self):
1441
self.checked_ok()
896
return self.checked_ok()
1442
897
1443
898
# Enable - method
1444
899
@dbus.service.method(_interface)
1466
921
## Properties
1467
922
1468
923
# ApprovalPending - property
1469
@dbus_service_property(_interface, signature="b", access="read")
924
@dbus_service_property(_interface, signature=u"b", access=u"read")
1470
925
def ApprovalPending_dbus_property(self):
1471
926
return dbus.Boolean(bool(self.approvals_pending))
1472
927
1473
928
# ApprovedByDefault - property
1474
@dbus_service_property(_interface,
1475
signature="b",
1476
access="readwrite")
929
@dbus_service_property(_interface, signature=u"b",
930
access=u"readwrite")
1477
931
def ApprovedByDefault_dbus_property(self, value=None):
1478
932
if value is None: # get
1479
933
return dbus.Boolean(self.approved_by_default)
1480
934
self.approved_by_default = bool(value)
935
# Emit D-Bus signal
936
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
937
dbus.Boolean(value, variant_level=1))
1481
938
1482
939
# ApprovalDelay - property
1483
@dbus_service_property(_interface,
1484
signature="t",
1485
access="readwrite")
940
@dbus_service_property(_interface, signature=u"t",
941
access=u"readwrite")
1486
942
def ApprovalDelay_dbus_property(self, value=None):
1487
943
if value is None: # get
1488
return dbus.UInt64(self.approval_delay.total_seconds()
1489
* 1000)
944
return dbus.UInt64(self.approval_delay_milliseconds())
1490
945
self.approval_delay = datetime.timedelta(0, 0, 0, value)
946
# Emit D-Bus signal
947
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
948
dbus.UInt64(value, variant_level=1))
1491
949
1492
950
# ApprovalDuration - property
1493
@dbus_service_property(_interface,
1494
signature="t",
1495
access="readwrite")
951
@dbus_service_property(_interface, signature=u"t",
952
access=u"readwrite")
1496
953
def ApprovalDuration_dbus_property(self, value=None):
1497
954
if value is None: # get
1498
return dbus.UInt64(self.approval_duration.total_seconds()
1499
* 1000)
955
return dbus.UInt64(self._timedelta_to_milliseconds(
956
self.approval_duration))
1500
957
self.approval_duration = datetime.timedelta(0, 0, 0, value)
958
# Emit D-Bus signal
959
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
960
dbus.UInt64(value, variant_level=1))
1501
961
1502
962
# Name - property
1503
@dbus_service_property(_interface, signature="s", access="read")
963
@dbus_service_property(_interface, signature=u"s", access=u"read")
1504
964
def Name_dbus_property(self):
1505
965
return dbus.String(self.name)
1506
966
1507
967
# Fingerprint - property
1508
@dbus_service_property(_interface, signature="s", access="read")
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
1509
969
def Fingerprint_dbus_property(self):
1510
970
return dbus.String(self.fingerprint)
1511
971
1512
972
# Host - property
1513
@dbus_service_property(_interface,
1514
signature="s",
1515
access="readwrite")
973
@dbus_service_property(_interface, signature=u"s",
974
access=u"readwrite")
1516
975
def Host_dbus_property(self, value=None):
1517
976
if value is None: # get
1518
977
return dbus.String(self.host)
1519
self.host = str(value)
978
self.host = value
979
# Emit D-Bus signal
980
self.PropertyChanged(dbus.String(u"Host"),
981
dbus.String(value, variant_level=1))
1520
982
1521
983
# Created - property
1522
@dbus_service_property(_interface, signature="s", access="read")
984
@dbus_service_property(_interface, signature=u"s", access=u"read")
1523
985
def Created_dbus_property(self):
1524
return datetime_to_dbus(self.created)
986
return dbus.String(self._datetime_to_dbus(self.created))
1525
987
1526
988
# LastEnabled - property
1527
@dbus_service_property(_interface, signature="s", access="read")
989
@dbus_service_property(_interface, signature=u"s", access=u"read")
1528
990
def LastEnabled_dbus_property(self):
1529
return datetime_to_dbus(self.last_enabled)
991
if self.last_enabled is None:
992
return dbus.String(u"")
993
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1530
994
1531
995
# Enabled - property
1532
@dbus_service_property(_interface,
1533
signature="b",
1534
access="readwrite")
996
@dbus_service_property(_interface, signature=u"b",
997
access=u"readwrite")
1535
998
def Enabled_dbus_property(self, value=None):
1536
999
if value is None: # get
1537
1000
return dbus.Boolean(self.enabled)
1541
1004
self.disable()
1542
1005
1543
1006
# LastCheckedOK - property
1544
@dbus_service_property(_interface,
1545
signature="s",
1546
access="readwrite")
1007
@dbus_service_property(_interface, signature=u"s",
1008
access=u"readwrite")
1547
1009
def LastCheckedOK_dbus_property(self, value=None):
1548
1010
if value is not None:
1549
1011
self.checked_ok()
1550
1012
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)
1013
if self.last_checked_ok is None:
1014
return dbus.String(u"")
1015
return dbus.String(self._datetime_to_dbus(self
1016
.last_checked_ok))
1567
1017
1568
1018
# Timeout - property
1569
@dbus_service_property(_interface,
1570
signature="t",
1571
access="readwrite")
1019
@dbus_service_property(_interface, signature=u"t",
1020
access=u"readwrite")
1572
1021
def Timeout_dbus_property(self, value=None):
1573
1022
if value is None: # get
1574
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1575
old_timeout = self.timeout
1023
return dbus.UInt64(self.timeout_milliseconds())
1576
1024
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)
1025
# Emit D-Bus signal
1026
self.PropertyChanged(dbus.String(u"Timeout"),
1027
dbus.UInt64(value, variant_level=1))
1028
if getattr(self, u"disable_initiator_tag", None) is None:
1029
return
1030
# Reschedule timeout
1031
gobject.source_remove(self.disable_initiator_tag)
1032
self.disable_initiator_tag = None
1033
time_to_die = (self.
1034
_timedelta_to_milliseconds((self
1035
.last_checked_ok
1036
+ self.timeout)
1037
- datetime.datetime
1038
.utcnow()))
1039
if time_to_die <= 0:
1040
# The timeout has passed
1041
self.disable()
1042
else:
1043
self.disable_initiator_tag = (gobject.timeout_add
1044
(time_to_die, self.disable))
1602
1045
1603
1046
# Interval - property
1604
@dbus_service_property(_interface,
1605
signature="t",
1606
access="readwrite")
1047
@dbus_service_property(_interface, signature=u"t",
1048
access=u"readwrite")
1607
1049
def Interval_dbus_property(self, value=None):
1608
1050
if value is None: # get
1609
return dbus.UInt64(self.interval.total_seconds() * 1000)
1051
return dbus.UInt64(self.interval_milliseconds())
1610
1052
self.interval = datetime.timedelta(0, 0, 0, value)
1611
if getattr(self, "checker_initiator_tag", None) is None:
1053
# Emit D-Bus signal
1054
self.PropertyChanged(dbus.String(u"Interval"),
1055
dbus.UInt64(value, variant_level=1))
1056
if getattr(self, u"checker_initiator_tag", None) is None:
1612
1057
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
1058
# Reschedule checker run
1059
gobject.source_remove(self.checker_initiator_tag)
1060
self.checker_initiator_tag = (gobject.timeout_add
1061
(value, self.start_checker))
1062
self.start_checker() # Start one now, too
1063
1620
1064
# Checker - property
1621
@dbus_service_property(_interface,
1622
signature="s",
1623
access="readwrite")
1065
@dbus_service_property(_interface, signature=u"s",
1066
access=u"readwrite")
1624
1067
def Checker_dbus_property(self, value=None):
1625
1068
if value is None: # get
1626
1069
return dbus.String(self.checker_command)
1627
self.checker_command = str(value)
1070
self.checker_command = value
1071
# Emit D-Bus signal
1072
self.PropertyChanged(dbus.String(u"Checker"),
1073
dbus.String(self.checker_command,
1074
variant_level=1))
1628
1075
1629
1076
# CheckerRunning - property
1630
@dbus_service_property(_interface,
1631
signature="b",
1632
access="readwrite")
1077
@dbus_service_property(_interface, signature=u"b",
1078
access=u"readwrite")
1633
1079
def CheckerRunning_dbus_property(self, value=None):
1634
1080
if value is None: # get
1635
1081
return dbus.Boolean(self.checker is not None)
1639
1085
self.stop_checker()
1640
1086
1641
1087
# ObjectPath - property
1642
@dbus_service_property(_interface, signature="o", access="read")
1088
@dbus_service_property(_interface, signature=u"o", access=u"read")
1643
1089
def ObjectPath_dbus_property(self):
1644
1090
return self.dbus_object_path # is already a dbus.ObjectPath
1645
1091
1646
1092
# Secret = property
1647
@dbus_service_property(_interface,
1648
signature="ay",
1649
access="write",
1650
byte_arrays=True)
1093
@dbus_service_property(_interface, signature=u"ay",
1094
access=u"write", byte_arrays=True)
1651
1095
def Secret_dbus_property(self, value):
1652
self.secret = bytes(value)
1096
self.secret = str(value)
1653
1097
1654
1098
del _interface
1655
1099
1660
1104
self._pipe.send(('init', fpr, address))
1661
1105
if not self._pipe.recv():
1662
1106
raise KeyError()
1663
1107
1664
1108
def __getattribute__(self, name):
1665
if name == '_pipe':
1109
if(name == '_pipe'):
1666
1110
return super(ProxyClient, self).__getattribute__(name)
1667
1111
self._pipe.send(('getattr', name))
1668
1112
data = self._pipe.recv()
1669
1113
if data[0] == 'data':
1670
1114
return data[1]
1671
1115
if data[0] == 'function':
1672
1673
1116
def func(*args, **kwargs):
1674
1117
self._pipe.send(('funcall', name, args, kwargs))
1675
1118
return self._pipe.recv()[1]
1676
1677
1119
return func
1678
1120
1679
1121
def __setattr__(self, name, value):
1680
if name == '_pipe':
1122
if(name == '_pipe'):
1681
1123
return super(ProxyClient, self).__setattr__(name, value)
1682
1124
self._pipe.send(('setattr', name, value))
1683
1125
1690
1132
1691
1133
def handle(self):
1692
1134
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",
1135
logger.info(u"TCP connection from: %s",
1136
unicode(self.client_address))
1137
logger.debug(u"Pipe FD: %d",
1696
1138
self.server.child_pipe.fileno())
1697
1698
session = gnutls.connection.ClientSession(
1699
self.request, gnutls.connection .X509Credentials())
1700
1139
1140
session = (gnutls.connection
1141
.ClientSession(self.request,
1142
gnutls.connection
1143
.X509Credentials()))
1144
1701
1145
# Note: gnutls.connection.X509Credentials is really a
1702
1146
# generic GnuTLS certificate credentials object so long as
1703
1147
# no X.509 keys are added to it. Therefore, we can use it
1704
1148
# here despite using OpenPGP certificates.
1705
1706
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1707
# "+AES-256-CBC", "+SHA1",
1708
# "+COMP-NULL", "+CTYPE-OPENPGP",
1709
# "+DHE-DSS"))
1149
1150
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1151
# u"+AES-256-CBC", u"+SHA1",
1152
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1153
# u"+DHE-DSS"))
1710
1154
# Use a fallback default, since this MUST be set.
1711
1155
priority = self.server.gnutls_priority
1712
1156
if priority is None:
1713
priority = "NORMAL"
1714
gnutls.library.functions.gnutls_priority_set_direct(
1715
session._c_object, priority, None)
1716
1157
priority = u"NORMAL"
1158
(gnutls.library.functions
1159
.gnutls_priority_set_direct(session._c_object,
1160
priority, None))
1161
1717
1162
# Start communication using the Mandos protocol
1718
1163
# Get protocol number
1719
1164
line = self.request.makefile().readline()
1720
logger.debug("Protocol version: %r", line)
1165
logger.debug(u"Protocol version: %r", line)
1721
1166
try:
1722
1167
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)
1168
raise RuntimeError
1169
except (ValueError, IndexError, RuntimeError), error:
1170
logger.error(u"Unknown protocol version: %s", error)
1726
1171
return
1727
1172
1728
1173
# Start GnuTLS connection
1729
1174
try:
1730
1175
session.handshake()
1731
except gnutls.errors.GNUTLSError as error:
1732
logger.warning("Handshake failed: %s", error)
1176
except gnutls.errors.GNUTLSError, error:
1177
logger.warning(u"Handshake failed: %s", error)
1733
1178
# Do not run session.bye() here: the session is not
1734
1179
# established. Just abandon the request.
1735
1180
return
1736
logger.debug("Handshake succeeded")
1737
1181
logger.debug(u"Handshake succeeded")
1182
1738
1183
approval_required = False
1739
1184
try:
1740
1185
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)
1186
fpr = self.fingerprint(self.peer_certificate
1187
(session))
1188
except (TypeError, gnutls.errors.GNUTLSError), error:
1189
logger.warning(u"Bad certificate: %s", error)
1746
1190
return
1747
logger.debug("Fingerprint: %s", fpr)
1748
1191
logger.debug(u"Fingerprint: %s", fpr)
1192
1749
1193
try:
1750
1194
client = ProxyClient(child_pipe, fpr,
1751
1195
self.client_address)
1759
1203
1760
1204
while True:
1761
1205
if not client.enabled:
1762
logger.info("Client %s is disabled",
1763
client.name)
1206
logger.warning(u"Client %s is disabled",
1207
client.name)
1764
1208
if self.server.use_dbus:
1765
1209
# Emit D-Bus signal
1766
client.Rejected("Disabled")
1210
client.Rejected("Disabled")
1767
1211
return
1768
1212
1769
if client.approved or not client.approval_delay:
1213
if client._approved or not client.approval_delay:
1770
1214
#We are approved or approval is disabled
1771
1215
break
1772
elif client.approved is None:
1773
logger.info("Client %s needs approval",
1216
elif client._approved is None:
1217
logger.info(u"Client %s needs approval",
1774
1218
client.name)
1775
1219
if self.server.use_dbus:
1776
1220
# Emit D-Bus signal
1777
1221
client.NeedApproval(
1778
client.approval_delay.total_seconds()
1779
* 1000, client.approved_by_default)
1222
client.approval_delay_milliseconds(),
1223
client.approved_by_default)
1780
1224
else:
1781
logger.warning("Client %s was not approved",
1225
logger.warning(u"Client %s was not approved",
1782
1226
client.name)
1783
1227
if self.server.use_dbus:
1784
1228
# Emit D-Bus signal
1786
1230
return
1787
1231
1788
1232
#wait until timeout or approved
1233
#x = float(client._timedelta_to_milliseconds(delay))
1789
1234
time = datetime.datetime.now()
1790
1235
client.changedstate.acquire()
1791
client.changedstate.wait(delay.total_seconds())
1236
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1792
1237
client.changedstate.release()
1793
1238
time2 = datetime.datetime.now()
1794
1239
if (time2 - time) >= delay:
1798
1243
client.name)
1799
1244
if self.server.use_dbus:
1800
1245
# Emit D-Bus signal
1801
client.Rejected("Approval timed out")
1246
client.Rejected("Timed out")
1802
1247
return
1803
1248
else:
1804
1249
break
1809
1254
while sent_size < len(client.secret):
1810
1255
try:
1811
1256
sent = session.send(client.secret[sent_size:])
1812
except gnutls.errors.GNUTLSError as error:
1813
logger.warning("gnutls send failed",
1814
exc_info=error)
1257
except (gnutls.errors.GNUTLSError), error:
1258
logger.warning("gnutls send failed")
1815
1259
return
1816
logger.debug("Sent: %d, remaining: %d", sent,
1817
len(client.secret) - (sent_size
1818
+ sent))
1260
logger.debug(u"Sent: %d, remaining: %d",
1261
sent, len(client.secret)
1262
- (sent_size + sent))
1819
1263
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)
1264
1265
logger.info(u"Sending secret to %s", client.name)
1266
# bump the timeout as if seen
1267
client.checked_ok()
1824
1268
if self.server.use_dbus:
1825
1269
# Emit D-Bus signal
1826
1270
client.GotSecret()
1830
1274
client.approvals_pending -= 1
1831
1275
try:
1832
1276
session.bye()
1833
except gnutls.errors.GNUTLSError as error:
1834
logger.warning("GnuTLS bye failed",
1835
exc_info=error)
1277
except (gnutls.errors.GNUTLSError), error:
1278
logger.warning("GnuTLS bye failed")
1836
1279
1837
1280
@staticmethod
1838
1281
def peer_certificate(session):
1839
1282
"Return the peer's OpenPGP certificate as a bytestring"
1840
1283
# If not an OpenPGP certificate...
1841
if (gnutls.library.functions.gnutls_certificate_type_get(
1842
session._c_object)
1284
if (gnutls.library.functions
1285
.gnutls_certificate_type_get(session._c_object)
1843
1286
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1844
1287
# ...do the normal thing
1845
1288
return session.peer_certificate
1848
1291
.gnutls_certificate_get_peers
1849
1292
(session._c_object, ctypes.byref(list_size)))
1850
1293
if not bool(cert_list) and list_size.value != 0:
1851
raise gnutls.errors.GNUTLSError("error getting peer"
1852
" certificate")
1294
raise gnutls.errors.GNUTLSError(u"error getting peer"
1295
u" certificate")
1853
1296
if list_size.value == 0:
1854
1297
return None
1855
1298
cert = cert_list[0]
1859
1302
def fingerprint(openpgp):
1860
1303
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1861
1304
# New GnuTLS "datum" with the OpenPGP public key
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)))
1305
datum = (gnutls.library.types
1306
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1307
ctypes.POINTER
1308
(ctypes.c_ubyte)),
1309
ctypes.c_uint(len(openpgp))))
1866
1310
# New empty GnuTLS certificate
1867
1311
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1868
gnutls.library.functions.gnutls_openpgp_crt_init(
1869
ctypes.byref(crt))
1312
(gnutls.library.functions
1313
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1870
1314
# Import the OpenPGP public key into the certificate
1871
gnutls.library.functions.gnutls_openpgp_crt_import(
1872
crt, ctypes.byref(datum),
1873
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1315
(gnutls.library.functions
1316
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1317
gnutls.library.constants
1318
.GNUTLS_OPENPGP_FMT_RAW))
1874
1319
# Verify the self signature in the key
1875
1320
crtverify = ctypes.c_uint()
1876
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1877
crt, 0, ctypes.byref(crtverify))
1321
(gnutls.library.functions
1322
.gnutls_openpgp_crt_verify_self(crt, 0,
1323
ctypes.byref(crtverify)))
1878
1324
if crtverify.value != 0:
1879
1325
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1880
raise gnutls.errors.CertificateSecurityError(
1881
"Verify failed")
1326
raise (gnutls.errors.CertificateSecurityError
1327
(u"Verify failed"))
1882
1328
# New buffer for the fingerprint
1883
1329
buf = ctypes.create_string_buffer(20)
1884
1330
buf_len = ctypes.c_size_t()
1885
1331
# Get the fingerprint from the certificate into the buffer
1886
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1887
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1332
(gnutls.library.functions
1333
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1334
ctypes.byref(buf_len)))
1888
1335
# Deinit the certificate
1889
1336
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1890
1337
# Convert the buffer to a Python bytestring
1891
1338
fpr = ctypes.string_at(buf, buf_len.value)
1892
1339
# Convert the bytestring to hexadecimal notation
1893
hex_fpr = binascii.hexlify(fpr).upper()
1340
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1894
1341
return hex_fpr
1895
1342
1896
1343
1897
1344
class MultiprocessingMixIn(object):
1898
1345
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1899
1900
1346
def sub_process_main(self, request, address):
1901
1347
try:
1902
1348
self.finish_request(request, address)
1903
except Exception:
1349
except:
1904
1350
self.handle_error(request, address)
1905
1351
self.close_request(request)
1906
1352
1907
1353
def process_request(self, request, address):
1908
1354
"""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
1355
multiprocessing.Process(target = self.sub_process_main,
1356
args = (request, address)).start()
1914
1357
1915
1358
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1916
1359
""" adds a pipe to the MixIn """
1917
1918
1360
def process_request(self, request, client_address):
1919
1361
"""Overrides and wraps the original process_request().
1920
1362
1921
1363
This function creates a new pipe in self.pipe
1922
1364
"""
1923
1365
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1924
1925
proc = MultiprocessingMixIn.process_request(self, request,
1926
client_address)
1366
1367
super(MultiprocessingMixInWithPipe,
1368
self).process_request(request, client_address)
1927
1369
self.child_pipe.close()
1928
self.add_pipe(parent_pipe, proc)
1929
1930
def add_pipe(self, parent_pipe, proc):
1370
self.add_pipe(parent_pipe)
1371
1372
def add_pipe(self, parent_pipe):
1931
1373
"""Dummy function; override as necessary"""
1932
raise NotImplementedError()
1933
1374
pass
1934
1375
1935
1376
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1936
1377
socketserver.TCPServer, object):
1941
1382
interface: None or a network interface name (string)
1942
1383
use_ipv6: Boolean; to use IPv6 or not
1943
1384
"""
1944
1945
1385
def __init__(self, server_address, RequestHandlerClass,
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
"""
1386
interface=None, use_ipv6=True):
1952
1387
self.interface = interface
1953
1388
if use_ipv6:
1954
1389
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.
1981
1390
socketserver.TCPServer.__init__(self, server_address,
1982
1391
RequestHandlerClass)
1983
1984
1392
def server_bind(self):
1985
1393
"""This overrides the normal server_bind() function
1986
1394
to bind to an interface if one was specified, and also NOT to
1987
1395
bind to an address or port if they were not specified."""
1988
1396
if self.interface is not None:
1989
1397
if SO_BINDTODEVICE is None:
1990
logger.error("SO_BINDTODEVICE does not exist;"
1991
" cannot bind to interface %s",
1398
logger.error(u"SO_BINDTODEVICE does not exist;"
1399
u" cannot bind to interface %s",
1992
1400
self.interface)
1993
1401
else:
1994
1402
try:
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)
1403
self.socket.setsockopt(socket.SOL_SOCKET,
1404
SO_BINDTODEVICE,
1405
str(self.interface
1406
+ u'\0'))
1407
except socket.error, error:
1408
if error[0] == errno.EPERM:
1409
logger.error(u"No permission to"
1410
u" bind to interface %s",
1411
self.interface)
1412
elif error[0] == errno.ENOPROTOOPT:
1413
logger.error(u"SO_BINDTODEVICE not available;"
1414
u" cannot bind to interface %s",
1415
self.interface)
2009
1416
else:
2010
1417
raise
2011
1418
# Only bind(2) the socket if we really need to.
2012
1419
if self.server_address[0] or self.server_address[1]:
2013
1420
if not self.server_address[0]:
2014
1421
if self.address_family == socket.AF_INET6:
2015
any_address = "::" # in6addr_any
1422
any_address = u"::" # in6addr_any
2016
1423
else:
2017
any_address = "0.0.0.0" # INADDR_ANY
1424
any_address = socket.INADDR_ANY
2018
1425
self.server_address = (any_address,
2019
1426
self.server_address[1])
2020
1427
elif not self.server_address[1]:
2021
self.server_address = (self.server_address[0], 0)
1428
self.server_address = (self.server_address[0],
1429
0)
2022
1430
# if self.interface:
2023
1431
# self.server_address = (self.server_address[0],
2024
1432
# 0, # port
2038
1446
2039
1447
Assumes a gobject.MainLoop event loop.
2040
1448
"""
2041
2042
1449
def __init__(self, server_address, RequestHandlerClass,
2043
interface=None,
2044
use_ipv6=True,
2045
clients=None,
2046
gnutls_priority=None,
2047
use_dbus=True,
2048
socketfd=None):
1450
interface=None, use_ipv6=True, clients=None,
1451
gnutls_priority=None, use_dbus=True):
2049
1452
self.enabled = False
2050
1453
self.clients = clients
2051
1454
if self.clients is None:
2052
self.clients = {}
1455
self.clients = set()
2053
1456
self.use_dbus = use_dbus
2054
1457
self.gnutls_priority = gnutls_priority
2055
1458
IPv6_TCPServer.__init__(self, server_address,
2056
1459
RequestHandlerClass,
2057
1460
interface = interface,
2058
use_ipv6 = use_ipv6,
2059
socketfd = socketfd)
2060
1461
use_ipv6 = use_ipv6)
2061
1462
def server_activate(self):
2062
1463
if self.enabled:
2063
1464
return socketserver.TCPServer.server_activate(self)
2064
2065
1465
def enable(self):
2066
1466
self.enabled = True
2067
2068
def add_pipe(self, parent_pipe, proc):
1467
def add_pipe(self, parent_pipe):
2069
1468
# Call "handle_ipc" for both data and EOF events
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,
1469
gobject.io_add_watch(parent_pipe.fileno(),
1470
gobject.IO_IN | gobject.IO_HUP,
1471
functools.partial(self.handle_ipc,
1472
parent_pipe = parent_pipe))
1473
1474
def handle_ipc(self, source, condition, parent_pipe=None,
2080
1475
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()
1476
condition_names = {
1477
gobject.IO_IN: u"IN", # There is data to read.
1478
gobject.IO_OUT: u"OUT", # Data can be written (without
1479
# blocking).
1480
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1481
gobject.IO_ERR: u"ERR", # Error condition.
1482
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1483
# broken, usually for pipes and
1484
# sockets).
1485
}
1486
conditions_string = ' | '.join(name
1487
for cond, name in
1488
condition_names.iteritems()
1489
if cond & condition)
1490
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1491
conditions_string)
1492
1493
# error or the other end of multiprocessing.Pipe has closed
1494
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2085
1495
return False
2086
1496
2087
1497
# Read a request from the child
2088
1498
request = parent_pipe.recv()
1499
logger.debug(u"IPC request: %s", repr(request))
2089
1500
command = request[0]
2090
1501
2091
1502
if command == 'init':
2092
1503
fpr = request[1]
2093
1504
address = request[2]
2094
1505
2095
for c in self.clients.itervalues():
1506
for c in self.clients:
2096
1507
if c.fingerprint == fpr:
2097
1508
client = c
2098
1509
break
2099
1510
else:
2100
logger.info("Client not found for fingerprint: %s, ad"
2101
"dress: %s", fpr, address)
1511
logger.warning(u"Client not found for fingerprint: %s, ad"
1512
u"dress: %s", fpr, address)
2102
1513
if self.use_dbus:
2103
1514
# Emit D-Bus signal
2104
mandos_dbus_service.ClientNotFound(fpr,
2105
address[0])
1515
mandos_dbus_service.ClientNotFound(fpr, address)
2106
1516
parent_pipe.send(False)
2107
1517
return False
2108
1518
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))
1519
gobject.io_add_watch(parent_pipe.fileno(),
1520
gobject.IO_IN | gobject.IO_HUP,
1521
functools.partial(self.handle_ipc,
1522
parent_pipe = parent_pipe,
1523
client_object = client))
2116
1524
parent_pipe.send(True)
2117
# remove the old hook in favor of the new above hook on
2118
# same fileno
1525
# remove the old hook in favor of the new above hook on same fileno
2119
1526
return False
2120
1527
if command == 'funcall':
2121
1528
funcname = request[1]
2122
1529
args = request[2]
2123
1530
kwargs = request[3]
2124
1531
2125
parent_pipe.send(('data', getattr(client_object,
2126
funcname)(*args,
2127
**kwargs)))
2128
1532
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1533
2129
1534
if command == 'getattr':
2130
1535
attrname = request[1]
2131
1536
if callable(client_object.__getattribute__(attrname)):
2132
parent_pipe.send(('function', ))
1537
parent_pipe.send(('function',))
2133
1538
else:
2134
parent_pipe.send((
2135
'data', client_object.__getattribute__(attrname)))
1539
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2136
1540
2137
1541
if command == 'setattr':
2138
1542
attrname = request[1]
2139
1543
value = request[2]
2140
1544
setattr(client_object, attrname, value)
2141
1545
2142
1546
return True
2143
1547
2144
1548
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
2242
else:
2243
# No currently valid tokens were found
2244
raise ValueError("Invalid RFC 3339 duration")
2245
# End token found
2246
return value
2247
2248
2249
1549
def string_to_delta(interval):
2250
1550
"""Parse a string and return a datetime.timedelta
2251
1551
2252
>>> string_to_delta('7d')
1552
>>> string_to_delta(u'7d')
2253
1553
datetime.timedelta(7)
2254
>>> string_to_delta('60s')
1554
>>> string_to_delta(u'60s')
2255
1555
datetime.timedelta(0, 60)
2256
>>> string_to_delta('60m')
1556
>>> string_to_delta(u'60m')
2257
1557
datetime.timedelta(0, 3600)
2258
>>> string_to_delta('24h')
1558
>>> string_to_delta(u'24h')
2259
1559
datetime.timedelta(1)
2260
>>> string_to_delta('1w')
1560
>>> string_to_delta(u'1w')
2261
1561
datetime.timedelta(7)
2262
>>> string_to_delta('5m 30s')
1562
>>> string_to_delta(u'5m 30s')
2263
1563
datetime.timedelta(0, 330)
2264
1564
"""
2265
2266
try:
2267
return rfc3339_duration_to_delta(interval)
2268
except ValueError:
2269
pass
2270
2271
1565
timevalue = datetime.timedelta(0)
2272
1566
for s in interval.split():
2273
1567
try:
2274
suffix = s[-1]
1568
suffix = unicode(s[-1])
2275
1569
value = int(s[:-1])
2276
if suffix == "d":
1570
if suffix == u"d":
2277
1571
delta = datetime.timedelta(value)
2278
elif suffix == "s":
1572
elif suffix == u"s":
2279
1573
delta = datetime.timedelta(0, value)
2280
elif suffix == "m":
1574
elif suffix == u"m":
2281
1575
delta = datetime.timedelta(0, 0, 0, 0, value)
2282
elif suffix == "h":
1576
elif suffix == u"h":
2283
1577
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2284
elif suffix == "w":
1578
elif suffix == u"w":
2285
1579
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2286
1580
else:
2287
raise ValueError("Unknown suffix {!r}".format(suffix))
2288
except IndexError as e:
2289
raise ValueError(*(e.args))
1581
raise ValueError(u"Unknown suffix %r" % suffix)
1582
except (ValueError, IndexError), e:
1583
raise ValueError(e.message)
2290
1584
timevalue += delta
2291
1585
return timevalue
2292
1586
2293
1587
1588
def if_nametoindex(interface):
1589
"""Call the C function if_nametoindex(), or equivalent
1590
1591
Note: This function cannot accept a unicode string."""
1592
global if_nametoindex
1593
try:
1594
if_nametoindex = (ctypes.cdll.LoadLibrary
1595
(ctypes.util.find_library(u"c"))
1596
.if_nametoindex)
1597
except (OSError, AttributeError):
1598
logger.warning(u"Doing if_nametoindex the hard way")
1599
def if_nametoindex(interface):
1600
"Get an interface index the hard way, i.e. using fcntl()"
1601
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1602
with contextlib.closing(socket.socket()) as s:
1603
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1604
struct.pack(str(u"16s16x"),
1605
interface))
1606
interface_index = struct.unpack(str(u"I"),
1607
ifreq[16:20])[0]
1608
return interface_index
1609
return if_nametoindex(interface)
1610
1611
2294
1612
def daemon(nochdir = False, noclose = False):
2295
1613
"""See daemon(3). Standard BSD Unix function.
2296
1614
2299
1617
sys.exit()
2300
1618
os.setsid()
2301
1619
if not nochdir:
2302
os.chdir("/")
1620
os.chdir(u"/")
2303
1621
if os.fork():
2304
1622
sys.exit()
2305
1623
if not noclose:
2306
1624
# Close all standard open file descriptors
2307
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1625
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2308
1626
if not stat.S_ISCHR(os.fstat(null).st_mode):
2309
1627
raise OSError(errno.ENODEV,
2310
"{} not a character device"
2311
.format(os.devnull))
1628
u"%s not a character device"
1629
% os.path.devnull)
2312
1630
os.dup2(null, sys.stdin.fileno())
2313
1631
os.dup2(null, sys.stdout.fileno())
2314
1632
os.dup2(null, sys.stderr.fileno())
2321
1639
##################################################################
2322
1640
# Parsing of options, both command line and config file
2323
1641
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()
1642
parser = optparse.OptionParser(version = "%%prog %s" % version)
1643
parser.add_option("-i", u"--interface", type=u"string",
1644
metavar="IF", help=u"Bind to interface IF")
1645
parser.add_option("-a", u"--address", type=u"string",
1646
help=u"Address to listen for requests on")
1647
parser.add_option("-p", u"--port", type=u"int",
1648
help=u"Port number to receive requests on")
1649
parser.add_option("--check", action=u"store_true",
1650
help=u"Run self-test")
1651
parser.add_option("--debug", action=u"store_true",
1652
help=u"Debug mode; run in foreground and log to"
1653
u" terminal")
1654
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1655
help=u"Debug level for stdout output")
1656
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1657
u" priority string (see GnuTLS documentation)")
1658
parser.add_option("--servicename", type=u"string",
1659
metavar=u"NAME", help=u"Zeroconf service name")
1660
parser.add_option("--configdir", type=u"string",
1661
default=u"/etc/mandos", metavar=u"DIR",
1662
help=u"Directory to search for configuration"
1663
u" files")
1664
parser.add_option("--no-dbus", action=u"store_false",
1665
dest=u"use_dbus", help=u"Do not provide D-Bus"
1666
u" system bus interface")
1667
parser.add_option("--no-ipv6", action=u"store_false",
1668
dest=u"use_ipv6", help=u"Do not use IPv6")
1669
options = parser.parse_args()[0]
2370
1670
2371
1671
if options.check:
2372
1672
import doctest
2373
fail_count, test_count = doctest.testmod()
2374
sys.exit(os.EX_OK if fail_count == 0 else 1)
1673
doctest.testmod()
1674
sys.exit()
2375
1675
2376
1676
# Default values for config file for server-global settings
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
}
1677
server_defaults = { u"interface": u"",
1678
u"address": u"",
1679
u"port": u"",
1680
u"debug": u"False",
1681
u"priority":
1682
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1683
u"servicename": u"Mandos",
1684
u"use_dbus": u"True",
1685
u"use_ipv6": u"True",
1686
u"debuglevel": u"",
1687
}
2394
1688
2395
1689
# Parse config file for server-global settings
2396
1690
server_config = configparser.SafeConfigParser(server_defaults)
2397
1691
del server_defaults
2398
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1692
server_config.read(os.path.join(options.configdir,
1693
u"mandos.conf"))
2399
1694
# Convert the SafeConfigParser object to a dict
2400
1695
server_settings = server_config.defaults()
2401
1696
# Use the appropriate methods on the non-string config options
2402
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2403
server_settings[option] = server_config.getboolean("DEFAULT",
1697
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1698
server_settings[option] = server_config.getboolean(u"DEFAULT",
2404
1699
option)
2405
1700
if server_settings["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"])
1701
server_settings["port"] = server_config.getint(u"DEFAULT",
1702
u"port")
2417
1703
del server_config
2418
1704
2419
1705
# Override the settings from the config file with command line
2420
1706
# options, if set.
2421
for option in ("interface", "address", "port", "debug",
2422
"priority", "servicename", "configdir", "use_dbus",
2423
"use_ipv6", "debuglevel", "restore", "statedir",
2424
"socket", "foreground", "zeroconf"):
1707
for option in (u"interface", u"address", u"port", u"debug",
1708
u"priority", u"servicename", u"configdir",
1709
u"use_dbus", u"use_ipv6", u"debuglevel"):
2425
1710
value = getattr(options, option)
2426
1711
if value is not None:
2427
1712
server_settings[option] = value
2428
1713
del options
2429
1714
# Force all strings to be unicode
2430
1715
for option in server_settings.keys():
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
1716
if type(server_settings[option]) is str:
1717
server_settings[option] = unicode(server_settings[option])
2441
1718
# Now we have our good server settings in "server_settings"
2442
1719
2443
1720
##################################################################
2444
1721
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
2450
1722
# For convenience
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"])))
1723
debug = server_settings[u"debug"]
1724
debuglevel = server_settings[u"debuglevel"]
1725
use_dbus = server_settings[u"use_dbus"]
1726
use_ipv6 = server_settings[u"use_ipv6"]
1727
1728
if server_settings[u"servicename"] != u"Mandos":
1729
syslogger.setFormatter(logging.Formatter
1730
(u'Mandos (%s) [%%(process)d]:'
1731
u' %%(levelname)s: %%(message)s'
1732
% server_settings[u"servicename"]))
2474
1733
2475
1734
# Parse config file with clients
2476
client_config = configparser.SafeConfigParser(Client
2477
.client_defaults)
2478
client_config.read(os.path.join(server_settings["configdir"],
2479
"clients.conf"))
1735
client_defaults = { u"timeout": u"1h",
1736
u"interval": u"5m",
1737
u"checker": u"fping -q -- %%(host)s",
1738
u"host": u"",
1739
u"approval_delay": u"0s",
1740
u"approval_duration": u"1s",
1741
}
1742
client_config = configparser.SafeConfigParser(client_defaults)
1743
client_config.read(os.path.join(server_settings[u"configdir"],
1744
u"clients.conf"))
2480
1745
2481
1746
global mandos_dbus_service
2482
1747
mandos_dbus_service = None
2483
1748
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)
1749
tcp_server = MandosServer((server_settings[u"address"],
1750
server_settings[u"port"]),
1751
ClientHandler,
1752
interface=(server_settings[u"interface"]
1753
or None),
1754
use_ipv6=use_ipv6,
1755
gnutls_priority=
1756
server_settings[u"priority"],
1757
use_dbus=use_dbus)
1758
pidfilename = u"/var/run/mandos.pid"
1759
try:
1760
pidfile = open(pidfilename, u"w")
1761
except IOError:
1762
logger.error(u"Could not open file %r", pidfilename)
2505
1763
2506
for name in ("_mandos", "mandos", "nobody"):
1764
try:
1765
uid = pwd.getpwnam(u"_mandos").pw_uid
1766
gid = pwd.getpwnam(u"_mandos").pw_gid
1767
except KeyError:
2507
1768
try:
2508
uid = pwd.getpwnam(name).pw_uid
2509
gid = pwd.getpwnam(name).pw_gid
2510
break
1769
uid = pwd.getpwnam(u"mandos").pw_uid
1770
gid = pwd.getpwnam(u"mandos").pw_gid
2511
1771
except KeyError:
2512
continue
2513
else:
2514
uid = 65534
2515
gid = 65534
1772
try:
1773
uid = pwd.getpwnam(u"nobody").pw_uid
1774
gid = pwd.getpwnam(u"nobody").pw_gid
1775
except KeyError:
1776
uid = 65534
1777
gid = 65534
2516
1778
try:
2517
1779
os.setgid(gid)
2518
1780
os.setuid(uid)
2519
except OSError as error:
2520
if error.errno != errno.EPERM:
2521
raise
1781
except OSError, error:
1782
if error[0] != errno.EPERM:
1783
raise error
2522
1784
1785
if not debug and not debuglevel:
1786
syslogger.setLevel(logging.WARNING)
1787
console.setLevel(logging.WARNING)
1788
if debuglevel:
1789
level = getattr(logging, debuglevel.upper())
1790
syslogger.setLevel(level)
1791
console.setLevel(level)
1792
2523
1793
if debug:
2524
1794
# Enable all possible GnuTLS debugging
2525
1795
2529
1799
2530
1800
@gnutls.library.types.gnutls_log_func
2531
1801
def debug_gnutls(level, string):
2532
logger.debug("GnuTLS: %s", string[:-1])
1802
logger.debug(u"GnuTLS: %s", string[:-1])
2533
1803
2534
gnutls.library.functions.gnutls_global_set_log_function(
2535
debug_gnutls)
1804
(gnutls.library.functions
1805
.gnutls_global_set_log_function(debug_gnutls))
2536
1806
2537
1807
# Redirect stdin so all checkers get /dev/null
2538
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1808
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2539
1809
os.dup2(null, sys.stdin.fileno())
2540
1810
if null > 2:
2541
1811
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()
1812
else:
1813
# No console logging
1814
logger.removeHandler(console)
1815
2551
1816
2552
1817
global main_loop
2553
1818
# From the Avahi example code
2554
DBusGMainLoop(set_as_default=True)
1819
DBusGMainLoop(set_as_default=True )
2555
1820
main_loop = gobject.MainLoop()
2556
1821
bus = dbus.SystemBus()
2557
1822
# End of Avahi example code
2558
1823
if use_dbus:
2559
1824
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)
1825
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1826
bus, do_not_queue=True)
1827
except dbus.exceptions.NameExistsException, e:
1828
logger.error(unicode(e) + u", disabling D-Bus")
2568
1829
use_dbus = False
2569
server_settings["use_dbus"] = False
1830
server_settings[u"use_dbus"] = False
2570
1831
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
1832
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1833
service = AvahiService(name = server_settings[u"servicename"],
1834
servicetype = u"_mandos._tcp",
1835
protocol = protocol, bus = bus)
1836
if server_settings["interface"]:
1837
service.interface = (if_nametoindex
1838
(str(server_settings[u"interface"])))
1839
1840
if not debug:
1841
# Close all input and output, do double fork, etc.
1842
daemon()
1843
2582
1844
global multiprocessing_manager
2583
1845
multiprocessing_manager = multiprocessing.Manager()
2584
1846
2585
1847
client_class = Client
2586
1848
if use_dbus:
2587
1849
client_class = functools.partial(ClientDBus, bus = bus)
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))
1850
def client_config_items(config, section):
1851
special_settings = {
1852
"approved_by_default":
1853
lambda: config.getboolean(section,
1854
"approved_by_default"),
1855
}
1856
for name, value in config.items(section):
2672
1857
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
1858
yield (name, special_settings[name]())
1859
except KeyError:
1860
yield (name, value)
1861
1862
tcp_server.clients.update(set(
1863
client_class(name = section,
1864
config= dict(client_config_items(
1865
client_config, section)))
1866
for section in client_config.sections()))
2698
1867
if not tcp_server.clients:
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)
1868
logger.warning(u"No clients defined")
1869
1870
try:
1871
with pidfile:
1872
pid = os.getpid()
1873
pidfile.write(str(pid) + "\n")
2710
1874
del pidfile
2711
del pidfilename
1875
except IOError:
1876
logger.error(u"Could not write to file %r with PID %d",
1877
pidfilename, pid)
1878
except NameError:
1879
# "pidfile" was never created
1880
pass
1881
del pidfilename
2712
1882
1883
if not debug:
1884
signal.signal(signal.SIGINT, signal.SIG_IGN)
2713
1885
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2714
1886
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2715
1887
2716
1888
if use_dbus:
2717
2718
@alternate_dbus_interfaces(
2719
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2720
class MandosDBusService(DBusObjectWithProperties):
1889
class MandosDBusService(dbus.service.Object):
2721
1890
"""A D-Bus proxy object"""
2722
2723
1891
def __init__(self):
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")
1892
dbus.service.Object.__init__(self, bus, u"/")
1893
_interface = u"se.bsnet.fukt.Mandos"
1894
1895
@dbus.service.signal(_interface, signature=u"o")
2735
1896
def ClientAdded(self, objpath):
2736
1897
"D-Bus signal"
2737
1898
pass
2738
1899
2739
@dbus.service.signal(_interface, signature="ss")
1900
@dbus.service.signal(_interface, signature=u"ss")
2740
1901
def ClientNotFound(self, fingerprint, address):
2741
1902
"D-Bus signal"
2742
1903
pass
2743
1904
2744
@dbus.service.signal(_interface, signature="os")
1905
@dbus.service.signal(_interface, signature=u"os")
2745
1906
def ClientRemoved(self, objpath, name):
2746
1907
"D-Bus signal"
2747
1908
pass
2748
1909
2749
@dbus.service.method(_interface, out_signature="ao")
1910
@dbus.service.method(_interface, out_signature=u"ao")
2750
1911
def GetAllClients(self):
2751
1912
"D-Bus method"
2752
return dbus.Array(c.dbus_object_path for c in
2753
tcp_server.clients.itervalues())
1913
return dbus.Array(c.dbus_object_path
1914
for c in tcp_server.clients)
2754
1915
2755
1916
@dbus.service.method(_interface,
2756
out_signature="a{oa{sv}}")
1917
out_signature=u"a{oa{sv}}")
2757
1918
def GetAllClientsWithProperties(self):
2758
1919
"D-Bus method"
2759
1920
return dbus.Dictionary(
2760
{ c.dbus_object_path: c.GetAll("")
2761
for c in tcp_server.clients.itervalues() },
2762
signature="oa{sv}")
1921
((c.dbus_object_path, c.GetAll(u""))
1922
for c in tcp_server.clients),
1923
signature=u"oa{sv}")
2763
1924
2764
@dbus.service.method(_interface, in_signature="o")
1925
@dbus.service.method(_interface, in_signature=u"o")
2765
1926
def RemoveClient(self, object_path):
2766
1927
"D-Bus method"
2767
for c in tcp_server.clients.itervalues():
1928
for c in tcp_server.clients:
2768
1929
if c.dbus_object_path == object_path:
2769
del tcp_server.clients[c.name]
1930
tcp_server.clients.remove(c)
2770
1931
c.remove_from_connection()
2771
1932
# Don't signal anything except ClientRemoved
2772
1933
c.disable(quiet=True)
2781
1942
2782
1943
def cleanup():
2783
1944
"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
1945
service.cleanup()
1946
2845
1947
while tcp_server.clients:
2846
name, client = tcp_server.clients.popitem()
1948
client = tcp_server.clients.pop()
2847
1949
if use_dbus:
2848
1950
client.remove_from_connection()
1951
client.disable_hook = None
2849
1952
# Don't signal anything except ClientRemoved
2850
1953
client.disable(quiet=True)
2851
1954
if use_dbus:
2852
1955
# Emit D-Bus signal
2853
mandos_dbus_service.ClientRemoved(
2854
client.dbus_object_path, client.name)
2855
client_settings.clear()
1956
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1957
client.name)
2856
1958
2857
1959
atexit.register(cleanup)
2858
1960
2859
for client in tcp_server.clients.itervalues():
1961
for client in tcp_server.clients:
2860
1962
if use_dbus:
2861
1963
# Emit D-Bus signal
2862
1964
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2863
# Need to initiate checking of clients
2864
if client.enabled:
2865
client.init_checker()
1965
client.enable()
2866
1966
2867
1967
tcp_server.enable()
2868
1968
tcp_server.server_activate()
2869
1969
2870
1970
# Find out what port we got
2871
if zeroconf:
2872
service.port = tcp_server.socket.getsockname()[1]
1971
service.port = tcp_server.socket.getsockname()[1]
2873
1972
if use_ipv6:
2874
logger.info("Now listening on address %r, port %d,"
2875
" flowinfo %d, scope_id %d",
2876
*tcp_server.socket.getsockname())
1973
logger.info(u"Now listening on address %r, port %d,"
1974
" flowinfo %d, scope_id %d"
1975
% tcp_server.socket.getsockname())
2877
1976
else: # IPv4
2878
logger.info("Now listening on address %r, port %d",
2879
*tcp_server.socket.getsockname())
1977
logger.info(u"Now listening on address %r, port %d"
1978
% tcp_server.socket.getsockname())
2880
1979
2881
1980
#service.interface = tcp_server.socket.getsockname()[3]
2882
1981
2883
1982
try:
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
1983
# From the Avahi example code
1984
try:
1985
service.activate()
1986
except dbus.exceptions.DBusException, error:
1987
logger.critical(u"DBusException: %s", error)
1988
cleanup()
1989
sys.exit(1)
1990
# End of Avahi example code
2893
1991
2894
1992
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2895
1993
lambda *args, **kwargs:
2896
1994
(tcp_server.handle_request
2897
1995
(*args[2:], **kwargs) or True))
2898
1996
2899
logger.debug("Starting main loop")
1997
logger.debug(u"Starting main loop")
2900
1998
main_loop.run()
2901
except AvahiError as error:
2902
logger.critical("Avahi Error", exc_info=error)
1999
except AvahiError, error:
2000
logger.critical(u"AvahiError: %s", error)
2903
2001
cleanup()
2904
2002
sys.exit(1)
2905
2003
except KeyboardInterrupt:
2906
2004
if debug:
2907
print("", file=sys.stderr)
2908
logger.debug("Server received KeyboardInterrupt")
2909
logger.debug("Server exiting")
2005
print >> sys.stderr
2006
logger.debug(u"Server received KeyboardInterrupt")
2007
logger.debug(u"Server exiting")
2910
2008
# Must run before the D-Bus bus name gets deregistered
2911
2009
cleanup()
2912
2010
2913
2914
2011
if __name__ == '__main__':
2915
2012
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0