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