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