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