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