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