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