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