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