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