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