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