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