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