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