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