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