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