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