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