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