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