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