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