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 501
- compare with another revision
- download diff
- download tarball
- view history from revision 501
- Committer: Teddy Hogeborn
- Date: 2011-09-26 19:34:23 UTC
- Revision ID: teddy@fukt.bsnet.se-20110926193423-5yc1fcv4joiwc1gq
* mandos-clients.conf.xml (OPTIONS/timeout): No longer used when
secret key is given;
refer to
"extended_timeout".
secret key is given;
refer to
"extended_timeout".
- 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.1"
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
295
152
self.server = None
296
153
self.bus = bus
297
154
self.entry_group_state_changed_match = None
298
299
def rename(self, remove=True):
155
def rename(self):
300
156
"""Derived from the Avahi example code"""
301
157
if self.rename_count >= self.max_renames:
302
158
logger.critical("No suitable Zeroconf service name found"
303
159
" after %i retries, exiting.",
304
160
self.rename_count)
305
161
raise AvahiServiceError("Too many renames")
306
self.name = str(
307
self.server.GetAlternativeServiceName(self.name))
308
self.rename_count += 1
162
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
309
163
logger.info("Changing Zeroconf service name to %r ...",
310
164
self.name)
311
if remove:
312
self.remove()
165
syslogger.setFormatter(logging.Formatter
166
('Mandos (%s) [%%(process)d]:'
167
' %%(levelname)s: %%(message)s'
168
% self.name))
169
self.remove()
313
170
try:
314
171
self.add()
315
172
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
173
logger.critical("DBusException: %s", error)
174
self.cleanup()
175
os._exit(1)
176
self.rename_count += 1
325
177
def remove(self):
326
178
"""Derived from the Avahi example code"""
327
179
if self.entry_group_state_changed_match is not None:
329
181
self.entry_group_state_changed_match = None
330
182
if self.group is not None:
331
183
self.group.Reset()
332
333
184
def add(self):
334
185
"""Derived from the Avahi example code"""
335
186
self.remove()
340
191
avahi.DBUS_INTERFACE_ENTRY_GROUP)
341
192
self.entry_group_state_changed_match = (
342
193
self.group.connect_to_signal(
343
'StateChanged', self.entry_group_state_changed))
194
'StateChanged', self .entry_group_state_changed))
344
195
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
345
196
self.name, self.type)
346
197
self.group.AddService(
352
203
dbus.UInt16(self.port),
353
204
avahi.string_array_to_txt_array(self.TXT))
354
205
self.group.Commit()
355
356
206
def entry_group_state_changed(self, state, error):
357
207
"""Derived from the Avahi example code"""
358
208
logger.debug("Avahi entry group state change: %i", state)
364
214
self.rename()
365
215
elif state == avahi.ENTRY_GROUP_FAILURE:
366
216
logger.critical("Avahi: Error in group state changed %s",
367
str(error))
368
raise AvahiGroupError("State changed: {!s}".format(error))
369
217
unicode(error))
218
raise AvahiGroupError("State changed: %s"
219
% unicode(error))
370
220
def cleanup(self):
371
221
"""Derived from the Avahi example code"""
372
222
if self.group is not None:
373
223
try:
374
224
self.group.Free()
375
225
except (dbus.exceptions.UnknownMethodException,
376
dbus.exceptions.DBusException):
226
dbus.exceptions.DBusException) as e:
377
227
pass
378
228
self.group = None
379
229
self.remove()
380
381
230
def server_state_changed(self, state, error=None):
382
231
"""Derived from the Avahi example code"""
383
232
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
}
233
bad_states = { avahi.SERVER_INVALID:
234
"Zeroconf server invalid",
235
avahi.SERVER_REGISTERING: None,
236
avahi.SERVER_COLLISION:
237
"Zeroconf server name collision",
238
avahi.SERVER_FAILURE:
239
"Zeroconf server failure" }
390
240
if state in bad_states:
391
241
if bad_states[state] is not None:
392
242
if error is None:
395
245
logger.error(bad_states[state] + ": %r", error)
396
246
self.cleanup()
397
247
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)
248
self.add()
410
249
else:
411
250
if error is None:
412
251
logger.debug("Unknown state: %r", state)
413
252
else:
414
253
logger.debug("Unknown state: %r: %r", state, error)
415
416
254
def activate(self):
417
255
"""Derived from the Avahi example code"""
418
256
if self.server is None:
422
260
follow_name_owner_changes=True),
423
261
avahi.DBUS_INTERFACE_SERVER)
424
262
self.server.connect_to_signal("StateChanged",
425
self.server_state_changed)
263
self.server_state_changed)
426
264
self.server_state_changed(self.server.GetState())
427
265
428
266
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
267
class Client(object):
449
268
"""A representation of a client host served by this server.
450
269
451
270
Attributes:
452
approved: bool(); 'None' if not yet approved/disapproved
271
_approved: bool(); 'None' if not yet approved/disapproved
453
272
approval_delay: datetime.timedelta(); Time to wait for approval
454
273
approval_duration: datetime.timedelta(); Duration of one approval
455
274
checker: subprocess.Popen(); a running checker process used
462
281
instance %(name)s can be used in the command.
463
282
checker_initiator_tag: a gobject event source tag, or None
464
283
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
284
current_checker_command: string; current running checker_command
285
disable_hook: If set, called by disable() as disable_hook(self)
468
286
disable_initiator_tag: a gobject event source tag, or None
469
287
enabled: bool()
470
288
fingerprint: string (40 or 32 hexadecimal digits); used to
473
291
interval: datetime.timedelta(); How often to start a new checker
474
292
last_approval_request: datetime.datetime(); (UTC) or None
475
293
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
294
last_enabled: datetime.datetime(); (UTC)
482
295
name: string; from the config file, used in log messages and
483
296
D-Bus identifiers
484
297
secret: bytestring; sent verbatim (over TLS) to client
485
298
timeout: datetime.timedelta(); How long from last_checked_ok
486
299
until this client is disabled
487
extended_timeout: extra long timeout when secret has been sent
300
extended_timeout: extra long timeout when password has been sent
488
301
runtime_expansions: Allowed attributes for runtime expansion.
489
302
expires: datetime.datetime(); time (UTC) when a client will be
490
303
disabled, or None
491
server_settings: The server_settings dict from main()
492
304
"""
493
305
494
306
runtime_expansions = ("approval_delay", "approval_duration",
495
"created", "enabled", "expires",
496
"fingerprint", "host", "interval",
497
"last_approval_request", "last_checked_ok",
307
"created", "enabled", "fingerprint",
308
"host", "interval", "last_checked_ok",
498
309
"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
310
511
311
@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):
312
def _timedelta_to_milliseconds(td):
313
"Convert a datetime.timedelta() to milliseconds"
314
return ((td.days * 24 * 60 * 60 * 1000)
315
+ (td.seconds * 1000)
316
+ (td.microseconds // 1000))
317
318
def timeout_milliseconds(self):
319
"Return the 'timeout' attribute in milliseconds"
320
return self._timedelta_to_milliseconds(self.timeout)
321
322
def extended_timeout_milliseconds(self):
323
"Return the 'extended_timeout' attribute in milliseconds"
324
return self._timedelta_to_milliseconds(self.extended_timeout)
325
326
def interval_milliseconds(self):
327
"Return the 'interval' attribute in milliseconds"
328
return self._timedelta_to_milliseconds(self.interval)
329
330
def approval_delay_milliseconds(self):
331
return self._timedelta_to_milliseconds(self.approval_delay)
332
333
def __init__(self, name = None, disable_hook=None, config=None):
334
"""Note: the 'checker' key in 'config' sets the
335
'checker_command' attribute and *not* the 'checker'
336
attribute."""
562
337
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
338
if config is None:
339
config = {}
580
340
logger.debug("Creating client %r", self.name)
341
# Uppercase and remove spaces from fingerprint for later
342
# comparison purposes with return value from the fingerprint()
343
# function
344
self.fingerprint = (config["fingerprint"].upper()
345
.replace(" ", ""))
581
346
logger.debug(" Fingerprint: %s", self.fingerprint)
582
self.created = settings.get("created",
583
datetime.datetime.utcnow())
584
585
# attributes specific for this server instance
347
if "secret" in config:
348
self.secret = config["secret"].decode("base64")
349
elif "secfile" in config:
350
with open(os.path.expanduser(os.path.expandvars
351
(config["secfile"])),
352
"rb") as secfile:
353
self.secret = secfile.read()
354
else:
355
raise TypeError("No secret or secfile for client %s"
356
% self.name)
357
self.host = config.get("host", "")
358
self.created = datetime.datetime.utcnow()
359
self.enabled = False
360
self.last_approval_request = None
361
self.last_enabled = None
362
self.last_checked_ok = None
363
self.timeout = string_to_delta(config["timeout"])
364
self.extended_timeout = string_to_delta(config["extended_timeout"])
365
self.interval = string_to_delta(config["interval"])
366
self.disable_hook = disable_hook
586
367
self.checker = None
587
368
self.checker_initiator_tag = None
588
369
self.disable_initiator_tag = None
370
self.expires = None
589
371
self.checker_callback_tag = None
372
self.checker_command = config["checker"]
590
373
self.current_checker_command = None
591
self.approved = None
374
self.last_connect = None
375
self._approved = None
376
self.approved_by_default = config.get("approved_by_default",
377
True)
592
378
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)
379
self.approval_delay = string_to_delta(
380
config["approval_delay"])
381
self.approval_duration = string_to_delta(
382
config["approval_duration"])
383
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
604
384
605
# Send notice to process children that client state has changed
606
385
def send_changedstate(self):
607
with self.changedstate:
608
self.changedstate.notify_all()
609
386
self.changedstate.acquire()
387
self.changedstate.notify_all()
388
self.changedstate.release()
389
610
390
def enable(self):
611
391
"""Start this client's checker and timeout hooks"""
612
392
if getattr(self, "enabled", False):
613
393
# Already enabled
614
394
return
395
self.send_changedstate()
396
self.last_enabled = datetime.datetime.utcnow()
397
# Schedule a new checker to be started an 'interval' from now,
398
# and every interval from then on.
399
self.checker_initiator_tag = (gobject.timeout_add
400
(self.interval_milliseconds(),
401
self.start_checker))
402
# Schedule a disable() when 'timeout' has passed
615
403
self.expires = datetime.datetime.utcnow() + self.timeout
404
self.disable_initiator_tag = (gobject.timeout_add
405
(self.timeout_milliseconds(),
406
self.disable))
616
407
self.enabled = True
617
self.last_enabled = datetime.datetime.utcnow()
618
self.init_checker()
619
self.send_changedstate()
408
# Also start a new checker *right now*.
409
self.start_checker()
620
410
621
411
def disable(self, quiet=True):
622
412
"""Disable this client."""
623
413
if not getattr(self, "enabled", False):
624
414
return False
625
415
if not quiet:
416
self.send_changedstate()
417
if not quiet:
626
418
logger.info("Disabling client %s", self.name)
627
if getattr(self, "disable_initiator_tag", None) is not None:
419
if getattr(self, "disable_initiator_tag", False):
628
420
gobject.source_remove(self.disable_initiator_tag)
629
421
self.disable_initiator_tag = None
630
422
self.expires = None
631
if getattr(self, "checker_initiator_tag", None) is not None:
423
if getattr(self, "checker_initiator_tag", False):
632
424
gobject.source_remove(self.checker_initiator_tag)
633
425
self.checker_initiator_tag = None
634
426
self.stop_checker()
427
if self.disable_hook:
428
self.disable_hook(self)
635
429
self.enabled = False
636
if not quiet:
637
self.send_changedstate()
638
430
# Do not run this again if called by a gobject.timeout_add
639
431
return False
640
432
641
433
def __del__(self):
434
self.disable_hook = None
642
435
self.disable()
643
436
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):
437
def checker_callback(self, pid, condition, command):
662
438
"""The checker has completed, so take appropriate actions."""
663
439
self.checker_callback_tag = None
664
440
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:
441
if os.WIFEXITED(condition):
442
exitstatus = os.WEXITSTATUS(condition)
443
if exitstatus == 0:
673
444
logger.info("Checker for %(name)s succeeded",
674
445
vars(self))
675
446
self.checked_ok()
676
447
else:
677
logger.info("Checker for %(name)s failed", vars(self))
448
logger.info("Checker for %(name)s failed",
449
vars(self))
678
450
else:
679
self.last_checker_status = -1
680
self.last_checker_signal = -returncode
681
451
logger.warning("Checker for %(name)s crashed?",
682
452
vars(self))
683
return False
684
685
def checked_ok(self):
686
"""Assert that the client has been seen, alive and well."""
687
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."""
453
454
def checked_ok(self, timeout=None):
455
"""Bump up the timeout for this client.
456
457
This should only be called when the client has been seen,
458
alive and well.
459
"""
694
460
if timeout is None:
695
461
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
462
self.last_checked_ok = datetime.datetime.utcnow()
463
gobject.source_remove(self.disable_initiator_tag)
464
self.expires = datetime.datetime.utcnow() + timeout
465
self.disable_initiator_tag = (gobject.timeout_add
466
(self._timedelta_to_milliseconds(timeout),
467
self.disable))
703
468
704
469
def need_approval(self):
705
470
self.last_approval_request = datetime.datetime.utcnow()
710
475
If a checker already exists, leave it running and do
711
476
nothing."""
712
477
# 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
478
# did that, then if a checker (for some reason) started
479
# running slowly and taking more than 'interval' time, the
480
# client would inevitably timeout, since no checker would get
481
# a chance to run to completion. If we instead leave running
717
482
# checkers alone, the checker would have to take more time
718
483
# than 'timeout' for the client to be disabled, which is as it
719
484
# should be.
720
485
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
486
# If a checker exists, make sure it is not a zombie
487
try:
488
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
489
except (AttributeError, OSError) as error:
490
if (isinstance(error, OSError)
491
and error.errno != errno.ECHILD):
492
raise error
493
else:
494
if pid:
495
logger.warning("Checker was a zombie")
496
gobject.source_remove(self.checker_callback_tag)
497
self.checker_callback(pid, status,
498
self.current_checker_command)
725
499
# Start a new checker if needed
726
500
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
501
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
502
# In case checker_command has exactly one % operator
503
command = self.checker_command % self.host
504
except TypeError:
505
# Escape attributes for the shell
506
escaped_attrs = dict(
507
(attr,
508
re.escape(unicode(str(getattr(self, attr, "")),
509
errors=
510
'replace')))
511
for attr in
512
self.runtime_expansions)
513
514
try:
515
command = self.checker_command % escaped_attrs
516
except TypeError as error:
517
logger.error('Could not format string "%s":'
518
' %s', self.checker_command, error)
519
return True # Try again later
738
520
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)
521
try:
522
logger.info("Starting checker %r for %s",
523
command, self.name)
524
# We don't need to redirect stdout and stderr, since
525
# in normal mode, that is already done by daemon(),
526
# and in debug mode we don't want to. (Stdin is
527
# always replaced by /dev/null.)
528
self.checker = subprocess.Popen(command,
529
close_fds=True,
530
shell=True, cwd="/")
531
self.checker_callback_tag = (gobject.child_watch_add
532
(self.checker.pid,
533
self.checker_callback,
534
data=command))
535
# The checker may have completed before the gobject
536
# watch was added. Check for this.
537
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
538
if pid:
539
gobject.source_remove(self.checker_callback_tag)
540
self.checker_callback(pid, status, command)
541
except OSError as error:
542
logger.error("Failed to start subprocess: %s",
543
error)
764
544
# Re-run this periodically if run by gobject.timeout_add
765
545
return True
766
546
772
552
if getattr(self, "checker", None) is None:
773
553
return
774
554
logger.debug("Stopping checker for %(name)s", vars(self))
775
self.checker.terminate()
555
try:
556
os.kill(self.checker.pid, signal.SIGTERM)
557
#time.sleep(0.5)
558
#if self.checker.poll() is None:
559
# os.kill(self.checker.pid, signal.SIGKILL)
560
except OSError as error:
561
if error.errno != errno.ESRCH: # No such process
562
raise
776
563
self.checker = None
777
564
778
779
def dbus_service_property(dbus_interface,
780
signature="v",
781
access="readwrite",
782
byte_arrays=False):
565
def dbus_service_property(dbus_interface, signature="v",
566
access="readwrite", byte_arrays=False):
783
567
"""Decorators for marking methods of a DBusObjectWithProperties to
784
568
become properties on the D-Bus.
785
569
794
578
# "Set" method, so we fail early here:
795
579
if byte_arrays and signature != "ay":
796
580
raise ValueError("Byte arrays not supported for non-'ay'"
797
" signature {!r}".format(signature))
798
581
" signature %r" % signature)
799
582
def decorator(func):
800
583
func._dbus_is_property = True
801
584
func._dbus_interface = dbus_interface
806
589
func._dbus_name = func._dbus_name[:-14]
807
590
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
808
591
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
592
return decorator
854
593
855
594
856
595
class DBusPropertyException(dbus.exceptions.DBusException):
857
596
"""A base class for D-Bus property-related exceptions
858
597
"""
859
pass
598
def __unicode__(self):
599
return unicode(str(self))
860
600
861
601
862
602
class DBusPropertyAccessException(DBusPropertyException):
871
611
pass
872
612
873
613
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):
614
class DBusObjectWithProperties(dbus.service.Object):
964
615
"""A D-Bus object with properties.
965
616
966
617
Classes inheriting from this can use the dbus_service_property
967
618
decorator to expose methods as D-Bus properties. It exposes the
968
619
standard Get(), Set(), and GetAll() methods on the D-Bus.
969
620
"""
970
621
622
@staticmethod
623
def _is_dbus_property(obj):
624
return getattr(obj, "_dbus_is_property", False)
625
626
def _get_all_dbus_properties(self):
627
"""Returns a generator of (name, attribute) pairs
628
"""
629
return ((prop._dbus_name, prop)
630
for name, prop in
631
inspect.getmembers(self, self._is_dbus_property))
632
971
633
def _get_dbus_property(self, interface_name, property_name):
972
634
"""Returns a bound method if one exists which is a D-Bus
973
635
property with the specified name and interface.
974
636
"""
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
637
for name in (property_name,
638
property_name + "_dbus_property"):
639
prop = getattr(self, name, None)
640
if (prop is None
641
or not self._is_dbus_property(prop)
642
or prop._dbus_name != property_name
643
or (interface_name and prop._dbus_interface
644
and interface_name != prop._dbus_interface)):
645
continue
646
return prop
982
647
# No such property
983
raise DBusPropertyNotFound("{}:{}.{}".format(
984
self.dbus_object_path, interface_name, property_name))
648
raise DBusPropertyNotFound(self.dbus_object_path + ":"
649
+ interface_name + "."
650
+ property_name)
985
651
986
@dbus.service.method(dbus.PROPERTIES_IFACE,
987
in_signature="ss",
652
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
988
653
out_signature="v")
989
654
def Get(self, interface_name, property_name):
990
655
"""Standard D-Bus property Get() method, see D-Bus standard.
1008
673
# The byte_arrays option is not supported yet on
1009
674
# signatures other than "ay".
1010
675
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))
676
raise ValueError
677
value = dbus.ByteArray(''.join(unichr(byte)
678
for byte in value))
1016
679
prop(value)
1017
680
1018
@dbus.service.method(dbus.PROPERTIES_IFACE,
1019
in_signature="s",
681
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1020
682
out_signature="a{sv}")
1021
683
def GetAll(self, interface_name):
1022
684
"""Standard D-Bus property GetAll() method, see D-Bus
1023
685
standard.
1024
686
1025
687
Note: Will not include properties with access="write".
1026
688
"""
1027
properties = {}
1028
for name, prop in self._get_all_dbus_things("property"):
689
all = {}
690
for name, prop in self._get_all_dbus_properties():
1029
691
if (interface_name
1030
692
and interface_name != prop._dbus_interface):
1031
693
# Interface non-empty but did not match
1035
697
continue
1036
698
value = prop()
1037
699
if not hasattr(value, "variant_level"):
1038
properties[name] = value
700
all[name] = value
1039
701
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
702
all[name] = type(value)(value, variant_level=
703
value.variant_level+1)
704
return dbus.Dictionary(all, signature="sv")
1051
705
1052
706
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1053
707
out_signature="s",
1054
708
path_keyword='object_path',
1055
709
connection_keyword='connection')
1056
710
def Introspect(self, object_path, connection):
1057
"""Overloading of standard D-Bus method.
1058
1059
Inserts property tags and interface annotation tags.
711
"""Standard D-Bus method, overloaded to insert property tags.
1060
712
"""
1061
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1062
object_path,
1063
connection)
713
xmlstring = dbus.service.Object.Introspect(self, object_path,
714
connection)
1064
715
try:
1065
716
document = xml.dom.minidom.parseString(xmlstring)
1066
1067
717
def make_tag(document, name, prop):
1068
718
e = document.createElement("property")
1069
719
e.setAttribute("name", name)
1070
720
e.setAttribute("type", prop._dbus_signature)
1071
721
e.setAttribute("access", prop._dbus_access)
1072
722
return e
1073
1074
723
for if_tag in document.getElementsByTagName("interface"):
1075
# Add property tags
1076
724
for tag in (make_tag(document, name, prop)
1077
725
for name, prop
1078
in self._get_all_dbus_things("property")
726
in self._get_all_dbus_properties()
1079
727
if prop._dbus_interface
1080
728
== if_tag.getAttribute("name")):
1081
729
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
730
# Add the names to the return values for the
1099
731
# "org.freedesktop.DBus.Properties" methods
1100
732
if (if_tag.getAttribute("name")
1115
747
except (AttributeError, xml.dom.DOMException,
1116
748
xml.parsers.expat.ExpatError) as error:
1117
749
logger.error("Failed to override Introspection method",
1118
exc_info=error)
750
error)
1119
751
return xmlstring
1120
752
1121
753
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
754
class ClientDBus(Client, DBusObjectWithProperties):
1313
755
"""A Client class using D-Bus
1314
756
1318
760
"""
1319
761
1320
762
runtime_expansions = (Client.runtime_expansions
1321
+ ("dbus_object_path", ))
1322
1323
_interface = "se.recompile.Mandos.Client"
763
+ ("dbus_object_path",))
1324
764
1325
765
# dbus.service.Object doesn't use super(), so we can't either.
1326
766
1327
767
def __init__(self, bus = None, *args, **kwargs):
768
self._approvals_pending = 0
1328
769
self.bus = bus
1329
770
Client.__init__(self, *args, **kwargs)
1330
771
# Only now, when this client is initialized, can it show up on
1331
772
# the D-Bus
1332
client_object_name = str(self.name).translate(
773
client_object_name = unicode(self.name).translate(
1333
774
{ord("."): ord("_"),
1334
775
ord("-"): ord("_")})
1335
self.dbus_object_path = dbus.ObjectPath(
1336
"/clients/" + client_object_name)
776
self.dbus_object_path = (dbus.ObjectPath
777
("/clients/" + client_object_name))
1337
778
DBusObjectWithProperties.__init__(self, self.bus,
1338
779
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
780
def _set_expires(self, value):
781
old_value = getattr(self, "_expires", None)
782
self._expires = value
783
if hasattr(self, "dbus_object_path") and old_value != value:
784
dbus_time = (self._datetime_to_dbus(self._expires,
785
variant_level=1))
786
self.PropertyChanged(dbus.String("Expires"),
787
dbus_time)
788
expires = property(lambda self: self._expires, _set_expires)
789
del _set_expires
790
791
def _get_approvals_pending(self):
792
return self._approvals_pending
793
def _set_approvals_pending(self, value):
794
old_value = self._approvals_pending
795
self._approvals_pending = value
796
bval = bool(value)
797
if (hasattr(self, "dbus_object_path")
798
and bval is not bool(old_value)):
799
dbus_bool = dbus.Boolean(bval, variant_level=1)
800
self.PropertyChanged(dbus.String("ApprovalPending"),
801
dbus_bool)
802
803
approvals_pending = property(_get_approvals_pending,
804
_set_approvals_pending)
805
del _get_approvals_pending, _set_approvals_pending
806
807
@staticmethod
808
def _datetime_to_dbus(dt, variant_level=0):
809
"""Convert a UTC datetime.datetime() to a D-Bus type."""
810
if dt is None:
811
return dbus.String("", variant_level = variant_level)
812
return dbus.String(dt.isoformat(),
813
variant_level=variant_level)
814
815
def enable(self):
816
oldstate = getattr(self, "enabled", False)
817
r = Client.enable(self)
818
if oldstate != self.enabled:
819
# Emit D-Bus signals
820
self.PropertyChanged(dbus.String("Enabled"),
821
dbus.Boolean(True, variant_level=1))
822
self.PropertyChanged(
823
dbus.String("LastEnabled"),
824
self._datetime_to_dbus(self.last_enabled,
825
variant_level=1))
826
return r
827
828
def disable(self, quiet = False):
829
oldstate = getattr(self, "enabled", False)
830
r = Client.disable(self, quiet=quiet)
831
if not quiet and oldstate != self.enabled:
832
# Emit D-Bus signal
833
self.PropertyChanged(dbus.String("Enabled"),
834
dbus.Boolean(False, variant_level=1))
835
return r
1420
836
1421
837
def __del__(self, *args, **kwargs):
1422
838
try:
1427
843
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1428
844
Client.__del__(self, *args, **kwargs)
1429
845
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:
846
def checker_callback(self, pid, condition, command,
847
*args, **kwargs):
848
self.checker_callback_tag = None
849
self.checker = None
850
# Emit D-Bus signal
851
self.PropertyChanged(dbus.String("CheckerRunning"),
852
dbus.Boolean(False, variant_level=1))
853
if os.WIFEXITED(condition):
854
exitstatus = os.WEXITSTATUS(condition)
1437
855
# Emit D-Bus signal
1438
856
self.CheckerCompleted(dbus.Int16(exitstatus),
1439
# This is specific to GNU libC
1440
dbus.Int64(exitstatus << 8),
857
dbus.Int64(condition),
1441
858
dbus.String(command))
1442
859
else:
1443
860
# Emit D-Bus signal
1444
861
self.CheckerCompleted(dbus.Int16(-1),
1445
dbus.Int64(
1446
# This is specific to GNU libC
1447
(exitstatus << 8)
1448
| self.last_checker_signal),
862
dbus.Int64(condition),
1449
863
dbus.String(command))
1450
return ret
864
865
return Client.checker_callback(self, pid, condition, command,
866
*args, **kwargs)
867
868
def checked_ok(self, *args, **kwargs):
869
Client.checked_ok(self, *args, **kwargs)
870
# Emit D-Bus signal
871
self.PropertyChanged(
872
dbus.String("LastCheckedOK"),
873
(self._datetime_to_dbus(self.last_checked_ok,
874
variant_level=1)))
875
876
def need_approval(self, *args, **kwargs):
877
r = Client.need_approval(self, *args, **kwargs)
878
# Emit D-Bus signal
879
self.PropertyChanged(
880
dbus.String("LastApprovalRequest"),
881
(self._datetime_to_dbus(self.last_approval_request,
882
variant_level=1)))
883
return r
1451
884
1452
885
def start_checker(self, *args, **kwargs):
1453
old_checker_pid = getattr(self.checker, "pid", None)
886
old_checker = self.checker
887
if self.checker is not None:
888
old_checker_pid = self.checker.pid
889
else:
890
old_checker_pid = None
1454
891
r = Client.start_checker(self, *args, **kwargs)
1455
892
# Only if new checker process was started
1456
893
if (self.checker is not None
1457
894
and old_checker_pid != self.checker.pid):
1458
895
# Emit D-Bus signal
1459
896
self.CheckerStarted(self.current_checker_command)
897
self.PropertyChanged(
898
dbus.String("CheckerRunning"),
899
dbus.Boolean(True, variant_level=1))
1460
900
return r
1461
901
902
def stop_checker(self, *args, **kwargs):
903
old_checker = getattr(self, "checker", None)
904
r = Client.stop_checker(self, *args, **kwargs)
905
if (old_checker is not None
906
and getattr(self, "checker", None) is None):
907
self.PropertyChanged(dbus.String("CheckerRunning"),
908
dbus.Boolean(False, variant_level=1))
909
return r
910
1462
911
def _reset_approved(self):
1463
self.approved = None
912
self._approved = None
1464
913
return False
1465
914
1466
915
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
916
self.send_changedstate()
917
self._approved = value
918
gobject.timeout_add(self._timedelta_to_milliseconds
919
(self.approval_duration),
920
self._reset_approved)
921
1471
922
1472
923
## D-Bus methods, signals & properties
1473
1474
## Interfaces
924
_interface = "se.bsnet.fukt.Mandos.Client"
1475
925
1476
926
## Signals
1477
927
1488
938
pass
1489
939
1490
940
# PropertyChanged - signal
1491
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1492
941
@dbus.service.signal(_interface, signature="sv")
1493
942
def PropertyChanged(self, property, value):
1494
943
"D-Bus signal"
1528
977
self.checked_ok()
1529
978
1530
979
# Enable - method
1531
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1532
980
@dbus.service.method(_interface)
1533
981
def Enable(self):
1534
982
"D-Bus method"
1535
983
self.enable()
1536
984
1537
985
# StartChecker - method
1538
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1539
986
@dbus.service.method(_interface)
1540
987
def StartChecker(self):
1541
988
"D-Bus method"
1542
989
self.start_checker()
1543
990
1544
991
# Disable - method
1545
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1546
992
@dbus.service.method(_interface)
1547
993
def Disable(self):
1548
994
"D-Bus method"
1549
995
self.disable()
1550
996
1551
997
# StopChecker - method
1552
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1553
998
@dbus.service.method(_interface)
1554
999
def StopChecker(self):
1555
1000
self.stop_checker()
1562
1007
return dbus.Boolean(bool(self.approvals_pending))
1563
1008
1564
1009
# ApprovedByDefault - property
1565
@dbus_service_property(_interface,
1566
signature="b",
1010
@dbus_service_property(_interface, signature="b",
1567
1011
access="readwrite")
1568
1012
def ApprovedByDefault_dbus_property(self, value=None):
1569
1013
if value is None: # get
1570
1014
return dbus.Boolean(self.approved_by_default)
1015
old_value = self.approved_by_default
1571
1016
self.approved_by_default = bool(value)
1017
# Emit D-Bus signal
1018
if old_value != self.approved_by_default:
1019
self.PropertyChanged(dbus.String("ApprovedByDefault"),
1020
dbus.Boolean(value, variant_level=1))
1572
1021
1573
1022
# ApprovalDelay - property
1574
@dbus_service_property(_interface,
1575
signature="t",
1023
@dbus_service_property(_interface, signature="t",
1576
1024
access="readwrite")
1577
1025
def ApprovalDelay_dbus_property(self, value=None):
1578
1026
if value is None: # get
1579
return dbus.UInt64(self.approval_delay.total_seconds()
1580
* 1000)
1027
return dbus.UInt64(self.approval_delay_milliseconds())
1028
old_value = self.approval_delay
1581
1029
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1030
# Emit D-Bus signal
1031
if old_value != self.approval_delay:
1032
self.PropertyChanged(dbus.String("ApprovalDelay"),
1033
dbus.UInt64(value, variant_level=1))
1582
1034
1583
1035
# ApprovalDuration - property
1584
@dbus_service_property(_interface,
1585
signature="t",
1036
@dbus_service_property(_interface, signature="t",
1586
1037
access="readwrite")
1587
1038
def ApprovalDuration_dbus_property(self, value=None):
1588
1039
if value is None: # get
1589
return dbus.UInt64(self.approval_duration.total_seconds()
1590
* 1000)
1040
return dbus.UInt64(self._timedelta_to_milliseconds(
1041
self.approval_duration))
1042
old_value = self.approval_duration
1591
1043
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1044
# Emit D-Bus signal
1045
if old_value != self.approval_duration:
1046
self.PropertyChanged(dbus.String("ApprovalDuration"),
1047
dbus.UInt64(value, variant_level=1))
1592
1048
1593
1049
# Name - property
1594
@dbus_annotations(
1595
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1596
1050
@dbus_service_property(_interface, signature="s", access="read")
1597
1051
def Name_dbus_property(self):
1598
1052
return dbus.String(self.name)
1599
1053
1600
1054
# Fingerprint - property
1601
@dbus_annotations(
1602
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1603
1055
@dbus_service_property(_interface, signature="s", access="read")
1604
1056
def Fingerprint_dbus_property(self):
1605
1057
return dbus.String(self.fingerprint)
1606
1058
1607
1059
# Host - property
1608
@dbus_service_property(_interface,
1609
signature="s",
1060
@dbus_service_property(_interface, signature="s",
1610
1061
access="readwrite")
1611
1062
def Host_dbus_property(self, value=None):
1612
1063
if value is None: # get
1613
1064
return dbus.String(self.host)
1614
self.host = str(value)
1065
old_value = self.host
1066
self.host = value
1067
# Emit D-Bus signal
1068
if old_value != self.host:
1069
self.PropertyChanged(dbus.String("Host"),
1070
dbus.String(value, variant_level=1))
1615
1071
1616
1072
# Created - property
1617
@dbus_annotations(
1618
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1619
1073
@dbus_service_property(_interface, signature="s", access="read")
1620
1074
def Created_dbus_property(self):
1621
return datetime_to_dbus(self.created)
1075
return dbus.String(self._datetime_to_dbus(self.created))
1622
1076
1623
1077
# LastEnabled - property
1624
1078
@dbus_service_property(_interface, signature="s", access="read")
1625
1079
def LastEnabled_dbus_property(self):
1626
return datetime_to_dbus(self.last_enabled)
1080
return self._datetime_to_dbus(self.last_enabled)
1627
1081
1628
1082
# Enabled - property
1629
@dbus_service_property(_interface,
1630
signature="b",
1083
@dbus_service_property(_interface, signature="b",
1631
1084
access="readwrite")
1632
1085
def Enabled_dbus_property(self, value=None):
1633
1086
if value is None: # get
1638
1091
self.disable()
1639
1092
1640
1093
# LastCheckedOK - property
1641
@dbus_service_property(_interface,
1642
signature="s",
1094
@dbus_service_property(_interface, signature="s",
1643
1095
access="readwrite")
1644
1096
def LastCheckedOK_dbus_property(self, value=None):
1645
1097
if value is not None:
1646
1098
self.checked_ok()
1647
1099
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)
1100
return self._datetime_to_dbus(self.last_checked_ok)
1654
1101
1655
1102
# Expires - property
1656
1103
@dbus_service_property(_interface, signature="s", access="read")
1657
1104
def Expires_dbus_property(self):
1658
return datetime_to_dbus(self.expires)
1105
return self._datetime_to_dbus(self.expires)
1659
1106
1660
1107
# LastApprovalRequest - property
1661
1108
@dbus_service_property(_interface, signature="s", access="read")
1662
1109
def LastApprovalRequest_dbus_property(self):
1663
return datetime_to_dbus(self.last_approval_request)
1110
return self._datetime_to_dbus(self.last_approval_request)
1664
1111
1665
1112
# Timeout - property
1666
@dbus_service_property(_interface,
1667
signature="t",
1113
@dbus_service_property(_interface, signature="t",
1668
1114
access="readwrite")
1669
1115
def Timeout_dbus_property(self, value=None):
1670
1116
if value is None: # get
1671
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1672
old_timeout = self.timeout
1117
return dbus.UInt64(self.timeout_milliseconds())
1118
old_value = self.timeout
1673
1119
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
1120
# Emit D-Bus signal
1121
if old_value != self.timeout:
1122
self.PropertyChanged(dbus.String("Timeout"),
1123
dbus.UInt64(value, variant_level=1))
1124
if getattr(self, "disable_initiator_tag", None) is None:
1125
return
1126
# Reschedule timeout
1127
gobject.source_remove(self.disable_initiator_tag)
1128
self.disable_initiator_tag = None
1129
self.expires = None
1130
time_to_die = (self.
1131
_timedelta_to_milliseconds((self
1132
.last_checked_ok
1133
+ self.timeout)
1134
- datetime.datetime
1135
.utcnow()))
1136
if time_to_die <= 0:
1137
# The timeout has passed
1138
self.disable()
1139
else:
1140
self.expires = (datetime.datetime.utcnow()
1141
+ datetime.timedelta(milliseconds = time_to_die))
1142
self.disable_initiator_tag = (gobject.timeout_add
1143
(time_to_die, self.disable))
1144
1690
1145
# ExtendedTimeout - property
1691
@dbus_service_property(_interface,
1692
signature="t",
1146
@dbus_service_property(_interface, signature="t",
1693
1147
access="readwrite")
1694
1148
def ExtendedTimeout_dbus_property(self, value=None):
1695
1149
if value is None: # get
1696
return dbus.UInt64(self.extended_timeout.total_seconds()
1697
* 1000)
1150
return dbus.UInt64(self.extended_timeout_milliseconds())
1151
old_value = self.extended_timeout
1698
1152
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1699
1153
# Emit D-Bus signal
1154
if old_value != self.extended_timeout:
1155
self.PropertyChanged(dbus.String("ExtendedTimeout"),
1156
dbus.UInt64(value, variant_level=1))
1157
1700
1158
# Interval - property
1701
@dbus_service_property(_interface,
1702
signature="t",
1159
@dbus_service_property(_interface, signature="t",
1703
1160
access="readwrite")
1704
1161
def Interval_dbus_property(self, value=None):
1705
1162
if value is None: # get
1706
return dbus.UInt64(self.interval.total_seconds() * 1000)
1163
return dbus.UInt64(self.interval_milliseconds())
1164
old_value = self.interval
1707
1165
self.interval = datetime.timedelta(0, 0, 0, value)
1166
# Emit D-Bus signal
1167
if old_value != self.interval:
1168
self.PropertyChanged(dbus.String("Interval"),
1169
dbus.UInt64(value, variant_level=1))
1708
1170
if getattr(self, "checker_initiator_tag", None) is None:
1709
1171
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
1172
# Reschedule checker run
1173
gobject.source_remove(self.checker_initiator_tag)
1174
self.checker_initiator_tag = (gobject.timeout_add
1175
(value, self.start_checker))
1176
self.start_checker() # Start one now, too
1177
1717
1178
# Checker - property
1718
@dbus_service_property(_interface,
1719
signature="s",
1179
@dbus_service_property(_interface, signature="s",
1720
1180
access="readwrite")
1721
1181
def Checker_dbus_property(self, value=None):
1722
1182
if value is None: # get
1723
1183
return dbus.String(self.checker_command)
1724
self.checker_command = str(value)
1184
old_value = self.checker_command
1185
self.checker_command = value
1186
# Emit D-Bus signal
1187
if old_value != self.checker_command:
1188
self.PropertyChanged(dbus.String("Checker"),
1189
dbus.String(self.checker_command,
1190
variant_level=1))
1725
1191
1726
1192
# CheckerRunning - property
1727
@dbus_service_property(_interface,
1728
signature="b",
1193
@dbus_service_property(_interface, signature="b",
1729
1194
access="readwrite")
1730
1195
def CheckerRunning_dbus_property(self, value=None):
1731
1196
if value is None: # get
1736
1201
self.stop_checker()
1737
1202
1738
1203
# ObjectPath - property
1739
@dbus_annotations(
1740
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
1741
"org.freedesktop.DBus.Deprecated": "true"})
1742
1204
@dbus_service_property(_interface, signature="o", access="read")
1743
1205
def ObjectPath_dbus_property(self):
1744
1206
return self.dbus_object_path # is already a dbus.ObjectPath
1745
1207
1746
1208
# 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)
1209
@dbus_service_property(_interface, signature="ay",
1210
access="write", byte_arrays=True)
1754
1211
def Secret_dbus_property(self, value):
1755
self.secret = bytes(value)
1212
self.secret = str(value)
1756
1213
1757
1214
del _interface
1758
1215
1762
1219
self._pipe = child_pipe
1763
1220
self._pipe.send(('init', fpr, address))
1764
1221
if not self._pipe.recv():
1765
raise KeyError(fpr)
1766
1222
raise KeyError()
1223
1767
1224
def __getattribute__(self, name):
1768
if name == '_pipe':
1225
if(name == '_pipe'):
1769
1226
return super(ProxyClient, self).__getattribute__(name)
1770
1227
self._pipe.send(('getattr', name))
1771
1228
data = self._pipe.recv()
1772
1229
if data[0] == 'data':
1773
1230
return data[1]
1774
1231
if data[0] == 'function':
1775
1776
1232
def func(*args, **kwargs):
1777
1233
self._pipe.send(('funcall', name, args, kwargs))
1778
1234
return self._pipe.recv()[1]
1779
1780
1235
return func
1781
1236
1782
1237
def __setattr__(self, name, value):
1783
if name == '_pipe':
1238
if(name == '_pipe'):
1784
1239
return super(ProxyClient, self).__setattr__(name, value)
1785
1240
self._pipe.send(('setattr', name, value))
1786
1241
1794
1249
def handle(self):
1795
1250
with contextlib.closing(self.server.child_pipe) as child_pipe:
1796
1251
logger.info("TCP connection from: %s",
1797
str(self.client_address))
1252
unicode(self.client_address))
1798
1253
logger.debug("Pipe FD: %d",
1799
1254
self.server.child_pipe.fileno())
1800
1801
session = gnutls.connection.ClientSession(
1802
self.request, gnutls.connection .X509Credentials())
1803
1255
1256
session = (gnutls.connection
1257
.ClientSession(self.request,
1258
gnutls.connection
1259
.X509Credentials()))
1260
1804
1261
# Note: gnutls.connection.X509Credentials is really a
1805
1262
# generic GnuTLS certificate credentials object so long as
1806
1263
# no X.509 keys are added to it. Therefore, we can use it
1807
1264
# here despite using OpenPGP certificates.
1808
1265
1809
1266
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1810
1267
# "+AES-256-CBC", "+SHA1",
1811
1268
# "+COMP-NULL", "+CTYPE-OPENPGP",
1814
1271
priority = self.server.gnutls_priority
1815
1272
if priority is None:
1816
1273
priority = "NORMAL"
1817
gnutls.library.functions.gnutls_priority_set_direct(
1818
session._c_object, priority, None)
1819
1274
(gnutls.library.functions
1275
.gnutls_priority_set_direct(session._c_object,
1276
priority, None))
1277
1820
1278
# Start communication using the Mandos protocol
1821
1279
# Get protocol number
1822
1280
line = self.request.makefile().readline()
1823
1281
logger.debug("Protocol version: %r", line)
1824
1282
try:
1825
1283
if int(line.strip().split()[0]) > 1:
1826
raise RuntimeError(line)
1284
raise RuntimeError
1827
1285
except (ValueError, IndexError, RuntimeError) as error:
1828
1286
logger.error("Unknown protocol version: %s", error)
1829
1287
return
1830
1288
1831
1289
# Start GnuTLS connection
1832
1290
try:
1833
1291
session.handshake()
1837
1295
# established. Just abandon the request.
1838
1296
return
1839
1297
logger.debug("Handshake succeeded")
1840
1298
1841
1299
approval_required = False
1842
1300
try:
1843
1301
try:
1844
fpr = self.fingerprint(
1845
self.peer_certificate(session))
1302
fpr = self.fingerprint(self.peer_certificate
1303
(session))
1846
1304
except (TypeError,
1847
1305
gnutls.errors.GNUTLSError) as error:
1848
1306
logger.warning("Bad certificate: %s", error)
1849
1307
return
1850
1308
logger.debug("Fingerprint: %s", fpr)
1851
1309
1852
1310
try:
1853
1311
client = ProxyClient(child_pipe, fpr,
1854
1312
self.client_address)
1863
1321
while True:
1864
1322
if not client.enabled:
1865
1323
logger.info("Client %s is disabled",
1866
client.name)
1324
client.name)
1867
1325
if self.server.use_dbus:
1868
1326
# Emit D-Bus signal
1869
client.Rejected("Disabled")
1327
client.Rejected("Disabled")
1870
1328
return
1871
1329
1872
if client.approved or not client.approval_delay:
1330
if client._approved or not client.approval_delay:
1873
1331
#We are approved or approval is disabled
1874
1332
break
1875
elif client.approved is None:
1333
elif client._approved is None:
1876
1334
logger.info("Client %s needs approval",
1877
1335
client.name)
1878
1336
if self.server.use_dbus:
1879
1337
# Emit D-Bus signal
1880
1338
client.NeedApproval(
1881
client.approval_delay.total_seconds()
1882
* 1000, client.approved_by_default)
1339
client.approval_delay_milliseconds(),
1340
client.approved_by_default)
1883
1341
else:
1884
1342
logger.warning("Client %s was not approved",
1885
1343
client.name)
1889
1347
return
1890
1348
1891
1349
#wait until timeout or approved
1350
#x = float(client._timedelta_to_milliseconds(delay))
1892
1351
time = datetime.datetime.now()
1893
1352
client.changedstate.acquire()
1894
client.changedstate.wait(delay.total_seconds())
1353
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1895
1354
client.changedstate.release()
1896
1355
time2 = datetime.datetime.now()
1897
1356
if (time2 - time) >= delay:
1913
1372
try:
1914
1373
sent = session.send(client.secret[sent_size:])
1915
1374
except gnutls.errors.GNUTLSError as error:
1916
logger.warning("gnutls send failed",
1917
exc_info=error)
1375
logger.warning("gnutls send failed")
1918
1376
return
1919
logger.debug("Sent: %d, remaining: %d", sent,
1920
len(client.secret) - (sent_size
1921
+ sent))
1377
logger.debug("Sent: %d, remaining: %d",
1378
sent, len(client.secret)
1379
- (sent_size + sent))
1922
1380
sent_size += sent
1923
1381
1924
1382
logger.info("Sending secret to %s", client.name)
1925
# bump the timeout using extended_timeout
1926
client.bump_timeout(client.extended_timeout)
1383
# bump the timeout as if seen
1384
client.checked_ok(client.extended_timeout)
1927
1385
if self.server.use_dbus:
1928
1386
# Emit D-Bus signal
1929
1387
client.GotSecret()
1934
1392
try:
1935
1393
session.bye()
1936
1394
except gnutls.errors.GNUTLSError as error:
1937
logger.warning("GnuTLS bye failed",
1938
exc_info=error)
1395
logger.warning("GnuTLS bye failed")
1939
1396
1940
1397
@staticmethod
1941
1398
def peer_certificate(session):
1942
1399
"Return the peer's OpenPGP certificate as a bytestring"
1943
1400
# If not an OpenPGP certificate...
1944
if (gnutls.library.functions.gnutls_certificate_type_get(
1945
session._c_object)
1401
if (gnutls.library.functions
1402
.gnutls_certificate_type_get(session._c_object)
1946
1403
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1947
1404
# ...do the normal thing
1948
1405
return session.peer_certificate
1962
1419
def fingerprint(openpgp):
1963
1420
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1964
1421
# 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)))
1422
datum = (gnutls.library.types
1423
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1424
ctypes.POINTER
1425
(ctypes.c_ubyte)),
1426
ctypes.c_uint(len(openpgp))))
1969
1427
# New empty GnuTLS certificate
1970
1428
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1971
gnutls.library.functions.gnutls_openpgp_crt_init(
1972
ctypes.byref(crt))
1429
(gnutls.library.functions
1430
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1973
1431
# 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)
1432
(gnutls.library.functions
1433
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1434
gnutls.library.constants
1435
.GNUTLS_OPENPGP_FMT_RAW))
1977
1436
# Verify the self signature in the key
1978
1437
crtverify = ctypes.c_uint()
1979
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1980
crt, 0, ctypes.byref(crtverify))
1438
(gnutls.library.functions
1439
.gnutls_openpgp_crt_verify_self(crt, 0,
1440
ctypes.byref(crtverify)))
1981
1441
if crtverify.value != 0:
1982
1442
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1983
raise gnutls.errors.CertificateSecurityError(
1984
"Verify failed")
1443
raise (gnutls.errors.CertificateSecurityError
1444
("Verify failed"))
1985
1445
# New buffer for the fingerprint
1986
1446
buf = ctypes.create_string_buffer(20)
1987
1447
buf_len = ctypes.c_size_t()
1988
1448
# 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))
1449
(gnutls.library.functions
1450
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1451
ctypes.byref(buf_len)))
1991
1452
# Deinit the certificate
1992
1453
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1993
1454
# Convert the buffer to a Python bytestring
1994
1455
fpr = ctypes.string_at(buf, buf_len.value)
1995
1456
# Convert the bytestring to hexadecimal notation
1996
hex_fpr = binascii.hexlify(fpr).upper()
1457
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1997
1458
return hex_fpr
1998
1459
1999
1460
2000
1461
class MultiprocessingMixIn(object):
2001
1462
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2002
2003
1463
def sub_process_main(self, request, address):
2004
1464
try:
2005
1465
self.finish_request(request, address)
2006
except Exception:
1466
except:
2007
1467
self.handle_error(request, address)
2008
1468
self.close_request(request)
2009
1469
2010
1470
def process_request(self, request, address):
2011
1471
"""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
1472
multiprocessing.Process(target = self.sub_process_main,
1473
args = (request, address)).start()
2017
1474
2018
1475
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2019
1476
""" adds a pipe to the MixIn """
2020
2021
1477
def process_request(self, request, client_address):
2022
1478
"""Overrides and wraps the original process_request().
2023
1479
2024
1480
This function creates a new pipe in self.pipe
2025
1481
"""
2026
1482
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2027
2028
proc = MultiprocessingMixIn.process_request(self, request,
2029
client_address)
1483
1484
super(MultiprocessingMixInWithPipe,
1485
self).process_request(request, client_address)
2030
1486
self.child_pipe.close()
2031
self.add_pipe(parent_pipe, proc)
2032
2033
def add_pipe(self, parent_pipe, proc):
1487
self.add_pipe(parent_pipe)
1488
1489
def add_pipe(self, parent_pipe):
2034
1490
"""Dummy function; override as necessary"""
2035
raise NotImplementedError()
2036
1491
raise NotImplementedError
2037
1492
2038
1493
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2039
1494
socketserver.TCPServer, object):
2044
1499
interface: None or a network interface name (string)
2045
1500
use_ipv6: Boolean; to use IPv6 or not
2046
1501
"""
2047
2048
1502
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
"""
1503
interface=None, use_ipv6=True):
2055
1504
self.interface = interface
2056
1505
if use_ipv6:
2057
1506
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
1507
socketserver.TCPServer.__init__(self, server_address,
2085
1508
RequestHandlerClass)
2086
2087
1509
def server_bind(self):
2088
1510
"""This overrides the normal server_bind() function
2089
1511
to bind to an interface if one was specified, and also NOT to
2095
1517
self.interface)
2096
1518
else:
2097
1519
try:
2098
self.socket.setsockopt(
2099
socket.SOL_SOCKET, SO_BINDTODEVICE,
2100
(self.interface + "\0").encode("utf-8"))
1520
self.socket.setsockopt(socket.SOL_SOCKET,
1521
SO_BINDTODEVICE,
1522
str(self.interface
1523
+ '\0'))
2101
1524
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:
1525
if error[0] == errno.EPERM:
1526
logger.error("No permission to"
1527
" bind to interface %s",
1528
self.interface)
1529
elif error[0] == errno.ENOPROTOOPT:
2106
1530
logger.error("SO_BINDTODEVICE not available;"
2107
1531
" cannot bind to interface %s",
2108
1532
self.interface)
2109
elif error.errno == errno.ENODEV:
2110
logger.error("Interface %s does not exist,"
2111
" cannot bind", self.interface)
2112
1533
else:
2113
1534
raise
2114
1535
# Only bind(2) the socket if we really need to.
2117
1538
if self.address_family == socket.AF_INET6:
2118
1539
any_address = "::" # in6addr_any
2119
1540
else:
2120
any_address = "0.0.0.0" # INADDR_ANY
1541
any_address = socket.INADDR_ANY
2121
1542
self.server_address = (any_address,
2122
1543
self.server_address[1])
2123
1544
elif not self.server_address[1]:
2124
self.server_address = (self.server_address[0], 0)
1545
self.server_address = (self.server_address[0],
1546
0)
2125
1547
# if self.interface:
2126
1548
# self.server_address = (self.server_address[0],
2127
1549
# 0, # port
2141
1563
2142
1564
Assumes a gobject.MainLoop event loop.
2143
1565
"""
2144
2145
1566
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):
1567
interface=None, use_ipv6=True, clients=None,
1568
gnutls_priority=None, use_dbus=True):
2152
1569
self.enabled = False
2153
1570
self.clients = clients
2154
1571
if self.clients is None:
2155
self.clients = {}
1572
self.clients = set()
2156
1573
self.use_dbus = use_dbus
2157
1574
self.gnutls_priority = gnutls_priority
2158
1575
IPv6_TCPServer.__init__(self, server_address,
2159
1576
RequestHandlerClass,
2160
1577
interface = interface,
2161
use_ipv6 = use_ipv6,
2162
socketfd = socketfd)
2163
1578
use_ipv6 = use_ipv6)
2164
1579
def server_activate(self):
2165
1580
if self.enabled:
2166
1581
return socketserver.TCPServer.server_activate(self)
2167
2168
1582
def enable(self):
2169
1583
self.enabled = True
2170
2171
def add_pipe(self, parent_pipe, proc):
1584
def add_pipe(self, parent_pipe):
2172
1585
# 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,
1586
gobject.io_add_watch(parent_pipe.fileno(),
1587
gobject.IO_IN | gobject.IO_HUP,
1588
functools.partial(self.handle_ipc,
1589
parent_pipe = parent_pipe))
1590
1591
def handle_ipc(self, source, condition, parent_pipe=None,
2183
1592
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()
1593
condition_names = {
1594
gobject.IO_IN: "IN", # There is data to read.
1595
gobject.IO_OUT: "OUT", # Data can be written (without
1596
# blocking).
1597
gobject.IO_PRI: "PRI", # There is urgent data to read.
1598
gobject.IO_ERR: "ERR", # Error condition.
1599
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1600
# broken, usually for pipes and
1601
# sockets).
1602
}
1603
conditions_string = ' | '.join(name
1604
for cond, name in
1605
condition_names.iteritems()
1606
if cond & condition)
1607
# error or the other end of multiprocessing.Pipe has closed
1608
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2188
1609
return False
2189
1610
2190
1611
# Read a request from the child
2195
1616
fpr = request[1]
2196
1617
address = request[2]
2197
1618
2198
for c in self.clients.itervalues():
1619
for c in self.clients:
2199
1620
if c.fingerprint == fpr:
2200
1621
client = c
2201
1622
break
2204
1625
"dress: %s", fpr, address)
2205
1626
if self.use_dbus:
2206
1627
# Emit D-Bus signal
2207
mandos_dbus_service.ClientNotFound(fpr,
2208
address[0])
1628
mandos_dbus_service.ClientNotFound(fpr, address[0])
2209
1629
parent_pipe.send(False)
2210
1630
return False
2211
1631
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))
1632
gobject.io_add_watch(parent_pipe.fileno(),
1633
gobject.IO_IN | gobject.IO_HUP,
1634
functools.partial(self.handle_ipc,
1635
parent_pipe = parent_pipe,
1636
client_object = client))
2219
1637
parent_pipe.send(True)
2220
# remove the old hook in favor of the new above hook on
2221
# same fileno
1638
# remove the old hook in favor of the new above hook on same fileno
2222
1639
return False
2223
1640
if command == 'funcall':
2224
1641
funcname = request[1]
2225
1642
args = request[2]
2226
1643
kwargs = request[3]
2227
1644
2228
parent_pipe.send(('data', getattr(client_object,
2229
funcname)(*args,
2230
**kwargs)))
2231
1645
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1646
2232
1647
if command == 'getattr':
2233
1648
attrname = request[1]
2234
if isinstance(client_object.__getattribute__(attrname),
2235
collections.Callable):
2236
parent_pipe.send(('function', ))
1649
if callable(client_object.__getattribute__(attrname)):
1650
parent_pipe.send(('function',))
2237
1651
else:
2238
parent_pipe.send((
2239
'data', client_object.__getattribute__(attrname)))
1652
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2240
1653
2241
1654
if command == 'setattr':
2242
1655
attrname = request[1]
2243
1656
value = request[2]
2244
1657
setattr(client_object, attrname, value)
2245
1658
2246
1659
return True
2247
1660
2248
1661
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
1662
def string_to_delta(interval):
2346
1663
"""Parse a string and return a datetime.timedelta
2347
1664
2358
1675
>>> string_to_delta('5m 30s')
2359
1676
datetime.timedelta(0, 330)
2360
1677
"""
2361
2362
try:
2363
return rfc3339_duration_to_delta(interval)
2364
except ValueError:
2365
pass
2366
2367
1678
timevalue = datetime.timedelta(0)
2368
1679
for s in interval.split():
2369
1680
try:
2370
suffix = s[-1]
1681
suffix = unicode(s[-1])
2371
1682
value = int(s[:-1])
2372
1683
if suffix == "d":
2373
1684
delta = datetime.timedelta(value)
2380
1691
elif suffix == "w":
2381
1692
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2382
1693
else:
2383
raise ValueError("Unknown suffix {!r}".format(suffix))
2384
except IndexError as e:
1694
raise ValueError("Unknown suffix %r" % suffix)
1695
except (ValueError, IndexError) as e:
2385
1696
raise ValueError(*(e.args))
2386
1697
timevalue += delta
2387
1698
return timevalue
2388
1699
2389
1700
1701
def if_nametoindex(interface):
1702
"""Call the C function if_nametoindex(), or equivalent
1703
1704
Note: This function cannot accept a unicode string."""
1705
global if_nametoindex
1706
try:
1707
if_nametoindex = (ctypes.cdll.LoadLibrary
1708
(ctypes.util.find_library("c"))
1709
.if_nametoindex)
1710
except (OSError, AttributeError):
1711
logger.warning("Doing if_nametoindex the hard way")
1712
def if_nametoindex(interface):
1713
"Get an interface index the hard way, i.e. using fcntl()"
1714
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1715
with contextlib.closing(socket.socket()) as s:
1716
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1717
struct.pack(str("16s16x"),
1718
interface))
1719
interface_index = struct.unpack(str("I"),
1720
ifreq[16:20])[0]
1721
return interface_index
1722
return if_nametoindex(interface)
1723
1724
2390
1725
def daemon(nochdir = False, noclose = False):
2391
1726
"""See daemon(3). Standard BSD Unix function.
2392
1727
2400
1735
sys.exit()
2401
1736
if not noclose:
2402
1737
# Close all standard open file descriptors
2403
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1738
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2404
1739
if not stat.S_ISCHR(os.fstat(null).st_mode):
2405
1740
raise OSError(errno.ENODEV,
2406
"{} not a character device"
2407
.format(os.devnull))
1741
"%s not a character device"
1742
% os.path.devnull)
2408
1743
os.dup2(null, sys.stdin.fileno())
2409
1744
os.dup2(null, sys.stdout.fileno())
2410
1745
os.dup2(null, sys.stderr.fileno())
2419
1754
2420
1755
parser = argparse.ArgumentParser()
2421
1756
parser.add_argument("-v", "--version", action="version",
2422
version = "%(prog)s {}".format(version),
1757
version = "%%(prog)s %s" % version,
2423
1758
help="show version number and exit")
2424
1759
parser.add_argument("-i", "--interface", metavar="IF",
2425
1760
help="Bind to interface IF")
2431
1766
help="Run self-test")
2432
1767
parser.add_argument("--debug", action="store_true",
2433
1768
help="Debug mode; run in foreground and log"
2434
" to terminal", default=None)
1769
" to terminal")
2435
1770
parser.add_argument("--debuglevel", metavar="LEVEL",
2436
1771
help="Debug level for stdout output")
2437
1772
parser.add_argument("--priority", help="GnuTLS"
2444
1779
" files")
2445
1780
parser.add_argument("--no-dbus", action="store_false",
2446
1781
dest="use_dbus", help="Do not provide D-Bus"
2447
" system bus interface", default=None)
1782
" system bus interface")
2448
1783
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
1784
dest="use_ipv6", help="Do not use IPv6")
2465
1785
options = parser.parse_args()
2466
1786
2467
1787
if options.check:
2468
1788
import doctest
2469
fail_count, test_count = doctest.testmod()
2470
sys.exit(os.EX_OK if fail_count == 0 else 1)
1789
doctest.testmod()
1790
sys.exit()
2471
1791
2472
1792
# Default values for config file for server-global settings
2473
1793
server_defaults = { "interface": "",
2475
1795
"port": "",
2476
1796
"debug": "False",
2477
1797
"priority":
2478
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2479
":+SIGN-DSA-SHA256",
1798
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2480
1799
"servicename": "Mandos",
2481
1800
"use_dbus": "True",
2482
1801
"use_ipv6": "True",
2483
1802
"debuglevel": "",
2484
"restore": "True",
2485
"socket": "",
2486
"statedir": "/var/lib/mandos",
2487
"foreground": "False",
2488
"zeroconf": "True",
2489
}
1803
}
2490
1804
2491
1805
# Parse config file for server-global settings
2492
1806
server_config = configparser.SafeConfigParser(server_defaults)
2493
1807
del server_defaults
2494
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1808
server_config.read(os.path.join(options.configdir,
1809
"mandos.conf"))
2495
1810
# Convert the SafeConfigParser object to a dict
2496
1811
server_settings = server_config.defaults()
2497
1812
# Use the appropriate methods on the non-string config options
2498
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1813
for option in ("debug", "use_dbus", "use_ipv6"):
2499
1814
server_settings[option] = server_config.getboolean("DEFAULT",
2500
1815
option)
2501
1816
if server_settings["port"]:
2502
1817
server_settings["port"] = server_config.getint("DEFAULT",
2503
1818
"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
1819
del server_config
2514
1820
2515
1821
# Override the settings from the config file with command line
2516
1822
# options, if set.
2517
1823
for option in ("interface", "address", "port", "debug",
2518
"priority", "servicename", "configdir", "use_dbus",
2519
"use_ipv6", "debuglevel", "restore", "statedir",
2520
"socket", "foreground", "zeroconf"):
1824
"priority", "servicename", "configdir",
1825
"use_dbus", "use_ipv6", "debuglevel"):
2521
1826
value = getattr(options, option)
2522
1827
if value is not None:
2523
1828
server_settings[option] = value
2524
1829
del options
2525
1830
# Force all strings to be unicode
2526
1831
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
1832
if type(server_settings[option]) is str:
1833
server_settings[option] = unicode(server_settings[option])
2537
1834
# Now we have our good server settings in "server_settings"
2538
1835
2539
1836
##################################################################
2540
1837
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
1838
# For convenience
2547
1839
debug = server_settings["debug"]
2548
1840
debuglevel = server_settings["debuglevel"]
2549
1841
use_dbus = server_settings["use_dbus"]
2550
1842
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
1843
2565
1844
if server_settings["servicename"] != "Mandos":
2566
syslogger.setFormatter(
2567
logging.Formatter('Mandos ({}) [%(process)d]:'
2568
' %(levelname)s: %(message)s'.format(
2569
server_settings["servicename"])))
1845
syslogger.setFormatter(logging.Formatter
1846
('Mandos (%s) [%%(process)d]:'
1847
' %%(levelname)s: %%(message)s'
1848
% server_settings["servicename"]))
2570
1849
2571
1850
# Parse config file with clients
2572
client_config = configparser.SafeConfigParser(Client
2573
.client_defaults)
1851
client_defaults = { "timeout": "5m",
1852
"extended_timeout": "15m",
1853
"interval": "2m",
1854
"checker": "fping -q -- %%(host)s",
1855
"host": "",
1856
"approval_delay": "0s",
1857
"approval_duration": "1s",
1858
}
1859
client_config = configparser.SafeConfigParser(client_defaults)
2574
1860
client_config.read(os.path.join(server_settings["configdir"],
2575
1861
"clients.conf"))
2576
1862
2577
1863
global mandos_dbus_service
2578
1864
mandos_dbus_service = None
2579
1865
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
1866
tcp_server = MandosServer((server_settings["address"],
1867
server_settings["port"]),
1868
ClientHandler,
1869
interface=(server_settings["interface"]
1870
or None),
1871
use_ipv6=use_ipv6,
1872
gnutls_priority=
1873
server_settings["priority"],
1874
use_dbus=use_dbus)
1875
if not debug:
1876
pidfilename = "/var/run/mandos.pid"
2596
1877
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)
1878
pidfile = open(pidfilename, "w")
1879
except IOError:
1880
logger.error("Could not open file %r", pidfilename)
2601
1881
2602
for name in ("_mandos", "mandos", "nobody"):
1882
try:
1883
uid = pwd.getpwnam("_mandos").pw_uid
1884
gid = pwd.getpwnam("_mandos").pw_gid
1885
except KeyError:
2603
1886
try:
2604
uid = pwd.getpwnam(name).pw_uid
2605
gid = pwd.getpwnam(name).pw_gid
2606
break
1887
uid = pwd.getpwnam("mandos").pw_uid
1888
gid = pwd.getpwnam("mandos").pw_gid
2607
1889
except KeyError:
2608
continue
2609
else:
2610
uid = 65534
2611
gid = 65534
1890
try:
1891
uid = pwd.getpwnam("nobody").pw_uid
1892
gid = pwd.getpwnam("nobody").pw_gid
1893
except KeyError:
1894
uid = 65534
1895
gid = 65534
2612
1896
try:
2613
1897
os.setgid(gid)
2614
1898
os.setuid(uid)
2615
1899
except OSError as error:
2616
if error.errno != errno.EPERM:
2617
raise
1900
if error[0] != errno.EPERM:
1901
raise error
2618
1902
1903
if not debug and not debuglevel:
1904
syslogger.setLevel(logging.WARNING)
1905
console.setLevel(logging.WARNING)
1906
if debuglevel:
1907
level = getattr(logging, debuglevel.upper())
1908
syslogger.setLevel(level)
1909
console.setLevel(level)
1910
2619
1911
if debug:
2620
1912
# Enable all possible GnuTLS debugging
2621
1913
2627
1919
def debug_gnutls(level, string):
2628
1920
logger.debug("GnuTLS: %s", string[:-1])
2629
1921
2630
gnutls.library.functions.gnutls_global_set_log_function(
2631
debug_gnutls)
1922
(gnutls.library.functions
1923
.gnutls_global_set_log_function(debug_gnutls))
2632
1924
2633
1925
# Redirect stdin so all checkers get /dev/null
2634
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1926
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2635
1927
os.dup2(null, sys.stdin.fileno())
2636
1928
if null > 2:
2637
1929
os.close(null)
1930
else:
1931
# No console logging
1932
logger.removeHandler(console)
2638
1933
2639
1934
# Need to fork before connecting to D-Bus
2640
if not foreground:
1935
if not debug:
2641
1936
# Close all input and output, do double fork, etc.
2642
1937
daemon()
2643
1938
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
1939
global main_loop
2649
1940
# From the Avahi example code
2650
DBusGMainLoop(set_as_default=True)
1941
DBusGMainLoop(set_as_default=True )
2651
1942
main_loop = gobject.MainLoop()
2652
1943
bus = dbus.SystemBus()
2653
1944
# End of Avahi example code
2654
1945
if use_dbus:
2655
1946
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)
1947
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1948
bus, do_not_queue=True)
1949
except dbus.exceptions.NameExistsException as e:
1950
logger.error(unicode(e) + ", disabling D-Bus")
2664
1951
use_dbus = False
2665
1952
server_settings["use_dbus"] = False
2666
1953
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"))
1954
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1955
service = AvahiService(name = server_settings["servicename"],
1956
servicetype = "_mandos._tcp",
1957
protocol = protocol, bus = bus)
1958
if server_settings["interface"]:
1959
service.interface = (if_nametoindex
1960
(str(server_settings["interface"])))
2677
1961
2678
1962
global multiprocessing_manager
2679
1963
multiprocessing_manager = multiprocessing.Manager()
2681
1965
client_class = Client
2682
1966
if use_dbus:
2683
1967
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))
1968
def client_config_items(config, section):
1969
special_settings = {
1970
"approved_by_default":
1971
lambda: config.getboolean(section,
1972
"approved_by_default"),
1973
}
1974
for name, value in config.items(section):
2768
1975
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
1976
yield (name, special_settings[name]())
1977
except KeyError:
1978
yield (name, value)
1979
1980
tcp_server.clients.update(set(
1981
client_class(name = section,
1982
config= dict(client_config_items(
1983
client_config, section)))
1984
for section in client_config.sections()))
2794
1985
if not tcp_server.clients:
2795
1986
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
1987
1988
if not debug:
1989
try:
1990
with pidfile:
1991
pid = os.getpid()
1992
pidfile.write(str(pid) + "\n".encode("utf-8"))
1993
del pidfile
1994
except IOError:
1995
logger.error("Could not write to file %r with PID %d",
1996
pidfilename, pid)
1997
except NameError:
1998
# "pidfile" was never created
1999
pass
2807
2000
del pidfilename
2808
2001
2002
signal.signal(signal.SIGINT, signal.SIG_IGN)
2003
2809
2004
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2810
2005
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2811
2006
2812
2007
if use_dbus:
2813
2814
@alternate_dbus_interfaces(
2815
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2816
class MandosDBusService(DBusObjectWithAnnotations):
2008
class MandosDBusService(dbus.service.Object):
2817
2009
"""A D-Bus proxy object"""
2818
2819
2010
def __init__(self):
2820
2011
dbus.service.Object.__init__(self, bus, "/")
2821
2822
_interface = "se.recompile.Mandos"
2012
_interface = "se.bsnet.fukt.Mandos"
2823
2013
2824
2014
@dbus.service.signal(_interface, signature="o")
2825
2015
def ClientAdded(self, objpath):
2839
2029
@dbus.service.method(_interface, out_signature="ao")
2840
2030
def GetAllClients(self):
2841
2031
"D-Bus method"
2842
return dbus.Array(c.dbus_object_path for c in
2843
tcp_server.clients.itervalues())
2032
return dbus.Array(c.dbus_object_path
2033
for c in tcp_server.clients)
2844
2034
2845
2035
@dbus.service.method(_interface,
2846
2036
out_signature="a{oa{sv}}")
2847
2037
def GetAllClientsWithProperties(self):
2848
2038
"D-Bus method"
2849
2039
return dbus.Dictionary(
2850
{ c.dbus_object_path: c.GetAll("")
2851
for c in tcp_server.clients.itervalues() },
2040
((c.dbus_object_path, c.GetAll(""))
2041
for c in tcp_server.clients),
2852
2042
signature="oa{sv}")
2853
2043
2854
2044
@dbus.service.method(_interface, in_signature="o")
2855
2045
def RemoveClient(self, object_path):
2856
2046
"D-Bus method"
2857
for c in tcp_server.clients.itervalues():
2047
for c in tcp_server.clients:
2858
2048
if c.dbus_object_path == object_path:
2859
del tcp_server.clients[c.name]
2049
tcp_server.clients.remove(c)
2860
2050
c.remove_from_connection()
2861
2051
# Don't signal anything except ClientRemoved
2862
2052
c.disable(quiet=True)
2871
2061
2872
2062
def cleanup():
2873
2063
"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
2064
service.cleanup()
2065
2935
2066
while tcp_server.clients:
2936
name, client = tcp_server.clients.popitem()
2067
client = tcp_server.clients.pop()
2937
2068
if use_dbus:
2938
2069
client.remove_from_connection()
2070
client.disable_hook = None
2939
2071
# Don't signal anything except ClientRemoved
2940
2072
client.disable(quiet=True)
2941
2073
if use_dbus:
2942
2074
# Emit D-Bus signal
2943
mandos_dbus_service.ClientRemoved(
2944
client.dbus_object_path, client.name)
2945
client_settings.clear()
2075
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2076
client.name)
2946
2077
2947
2078
atexit.register(cleanup)
2948
2079
2949
for client in tcp_server.clients.itervalues():
2080
for client in tcp_server.clients:
2950
2081
if use_dbus:
2951
2082
# Emit D-Bus signal
2952
2083
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2953
# Need to initiate checking of clients
2954
if client.enabled:
2955
client.init_checker()
2084
client.enable()
2956
2085
2957
2086
tcp_server.enable()
2958
2087
tcp_server.server_activate()
2959
2088
2960
2089
# Find out what port we got
2961
if zeroconf:
2962
service.port = tcp_server.socket.getsockname()[1]
2090
service.port = tcp_server.socket.getsockname()[1]
2963
2091
if use_ipv6:
2964
2092
logger.info("Now listening on address %r, port %d,"
2965
" flowinfo %d, scope_id %d",
2966
*tcp_server.socket.getsockname())
2093
" flowinfo %d, scope_id %d"
2094
% tcp_server.socket.getsockname())
2967
2095
else: # IPv4
2968
logger.info("Now listening on address %r, port %d",
2969
*tcp_server.socket.getsockname())
2096
logger.info("Now listening on address %r, port %d"
2097
% tcp_server.socket.getsockname())
2970
2098
2971
2099
#service.interface = tcp_server.socket.getsockname()[3]
2972
2100
2973
2101
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
2102
# From the Avahi example code
2103
try:
2104
service.activate()
2105
except dbus.exceptions.DBusException as error:
2106
logger.critical("DBusException: %s", error)
2107
cleanup()
2108
sys.exit(1)
2109
# End of Avahi example code
2983
2110
2984
2111
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2985
2112
lambda *args, **kwargs:
2989
2116
logger.debug("Starting main loop")
2990
2117
main_loop.run()
2991
2118
except AvahiError as error:
2992
logger.critical("Avahi Error", exc_info=error)
2119
logger.critical("AvahiError: %s", error)
2993
2120
cleanup()
2994
2121
sys.exit(1)
2995
2122
except KeyboardInterrupt:
3000
2127
# Must run before the D-Bus bus name gets deregistered
3001
2128
cleanup()
3002
2129
3003
3004
2130
if __name__ == '__main__':
3005
2131
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0