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