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