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