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