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