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
_approved: bool(); 'None' if not yet approved/disapproved
452
approved: bool(); 'None' if not yet approved/disapproved
244
453
approval_delay: datetime.timedelta(); Time to wait for approval
245
454
approval_duration: datetime.timedelta(); Duration of one approval
246
455
checker: subprocess.Popen(); a running checker process used
247
456
to see if the client lives.
248
457
'None' if no process is running.
249
checker_callback_tag: - '' -
458
checker_callback_tag: a gobject event source tag, or None
250
459
checker_command: string; External command which is run to check
251
460
if client lives. %() expansions are done at
252
461
runtime with vars(self) as dict, so that for
253
462
instance %(name)s can be used in the command.
254
463
checker_initiator_tag: a gobject event source tag, or None
255
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
256
467
current_checker_command: string; current running checker_command
257
disable_hook: If set, called by disable() as disable_hook(self)
258
disable_initiator_tag: - '' -
468
disable_initiator_tag: a gobject event source tag, or None
259
469
enabled: bool()
260
470
fingerprint: string (40 or 32 hexadecimal digits); used to
261
471
uniquely identify the client
262
472
host: string; available for use by the checker command
263
473
interval: datetime.timedelta(); How often to start a new checker
474
last_approval_request: datetime.datetime(); (UTC) or None
264
475
last_checked_ok: datetime.datetime(); (UTC) or None
265
last_enabled: datetime.datetime(); (UTC)
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
266
482
name: string; from the config file, used in log messages and
267
483
D-Bus identifiers
268
484
secret: bytestring; sent verbatim (over TLS) to client
269
485
timeout: datetime.timedelta(); How long from last_checked_ok
270
486
until this client is disabled
487
extended_timeout: extra long timeout when secret has been sent
271
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()
272
492
"""
273
493
274
runtime_expansions = (u"approval_delay", u"approval_duration",
275
u"created", u"enabled", u"fingerprint",
276
u"host", u"interval", u"last_checked_ok",
277
u"last_enabled", u"name", u"timeout")
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
}
278
510
279
511
@staticmethod
280
def _timedelta_to_milliseconds(td):
281
"Convert a datetime.timedelta() to milliseconds"
282
return ((td.days * 24 * 60 * 60 * 1000)
283
+ (td.seconds * 1000)
284
+ (td.microseconds // 1000))
285
286
def timeout_milliseconds(self):
287
"Return the 'timeout' attribute in milliseconds"
288
return self._timedelta_to_milliseconds(self.timeout)
289
290
def interval_milliseconds(self):
291
"Return the 'interval' attribute in milliseconds"
292
return self._timedelta_to_milliseconds(self.interval)
293
294
def approval_delay_milliseconds(self):
295
return self._timedelta_to_milliseconds(self.approval_delay)
296
297
def __init__(self, name = None, disable_hook=None, config=None):
298
"""Note: the 'checker' key in 'config' sets the
299
'checker_command' attribute and *not* the 'checker'
300
attribute."""
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):
301
562
self.name = name
302
if config is None:
303
config = {}
304
logger.debug(u"Creating client %r", self.name)
305
# Uppercase and remove spaces from fingerprint for later
306
# comparison purposes with return value from the fingerprint()
307
# function
308
self.fingerprint = (config[u"fingerprint"].upper()
309
.replace(u" ", u""))
310
logger.debug(u" Fingerprint: %s", self.fingerprint)
311
if u"secret" in config:
312
self.secret = config[u"secret"].decode(u"base64")
313
elif u"secfile" in config:
314
with open(os.path.expanduser(os.path.expandvars
315
(config[u"secfile"])),
316
"rb") as secfile:
317
self.secret = secfile.read()
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)
318
576
else:
319
raise TypeError(u"No secret or secfile for client %s"
320
% self.name)
321
self.host = config.get(u"host", u"")
322
self.created = datetime.datetime.utcnow()
323
self.enabled = False
324
self.last_enabled = None
325
self.last_checked_ok = None
326
self.timeout = string_to_delta(config[u"timeout"])
327
self.interval = string_to_delta(config[u"interval"])
328
self.disable_hook = disable_hook
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
329
586
self.checker = None
330
587
self.checker_initiator_tag = None
331
588
self.disable_initiator_tag = None
332
589
self.checker_callback_tag = None
333
self.checker_command = config[u"checker"]
334
590
self.current_checker_command = None
335
self.last_connect = None
336
self._approved = None
337
self.approved_by_default = config.get(u"approved_by_default",
338
True)
591
self.approved = None
339
592
self.approvals_pending = 0
340
self.approval_delay = string_to_delta(
341
config[u"approval_delay"])
342
self.approval_duration = string_to_delta(
343
config[u"approval_duration"])
344
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
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)
345
604
605
# Send notice to process children that client state has changed
346
606
def send_changedstate(self):
347
self.changedstate.acquire()
348
self.changedstate.notify_all()
349
self.changedstate.release()
350
607
with self.changedstate:
608
self.changedstate.notify_all()
609
351
610
def enable(self):
352
611
"""Start this client's checker and timeout hooks"""
353
if getattr(self, u"enabled", False):
612
if getattr(self, "enabled", False):
354
613
# Already enabled
355
614
return
356
self.send_changedstate()
615
self.expires = datetime.datetime.utcnow() + self.timeout
616
self.enabled = True
357
617
self.last_enabled = datetime.datetime.utcnow()
358
# Schedule a new checker to be started an 'interval' from now,
359
# and every interval from then on.
360
self.checker_initiator_tag = (gobject.timeout_add
361
(self.interval_milliseconds(),
362
self.start_checker))
363
# Schedule a disable() when 'timeout' has passed
364
self.disable_initiator_tag = (gobject.timeout_add
365
(self.timeout_milliseconds(),
366
self.disable))
367
self.enabled = True
368
# Also start a new checker *right now*.
369
self.start_checker()
618
self.init_checker()
619
self.send_changedstate()
370
620
371
621
def disable(self, quiet=True):
372
622
"""Disable this client."""
373
623
if not getattr(self, "enabled", False):
374
624
return False
375
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:
376
637
self.send_changedstate()
377
if not quiet:
378
logger.info(u"Disabling client %s", self.name)
379
if getattr(self, u"disable_initiator_tag", False):
380
gobject.source_remove(self.disable_initiator_tag)
381
self.disable_initiator_tag = None
382
if getattr(self, u"checker_initiator_tag", False):
383
gobject.source_remove(self.checker_initiator_tag)
384
self.checker_initiator_tag = None
385
self.stop_checker()
386
if self.disable_hook:
387
self.disable_hook(self)
388
self.enabled = False
389
638
# Do not run this again if called by a gobject.timeout_add
390
639
return False
391
640
392
641
def __del__(self):
393
self.disable_hook = None
394
642
self.disable()
395
643
396
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):
397
662
"""The checker has completed, so take appropriate actions."""
398
663
self.checker_callback_tag = None
399
664
self.checker = None
400
if os.WIFEXITED(condition):
401
exitstatus = os.WEXITSTATUS(condition)
402
if exitstatus == 0:
403
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",
404
674
vars(self))
405
675
self.checked_ok()
406
676
else:
407
logger.info(u"Checker for %(name)s failed",
408
vars(self))
677
logger.info("Checker for %(name)s failed", vars(self))
409
678
else:
410
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?",
411
682
vars(self))
683
return False
412
684
413
685
def checked_ok(self):
414
"""Bump up the timeout for this client.
415
416
This should only be called when the client has been seen,
417
alive and well.
418
"""
686
"""Assert that the client has been seen, alive and well."""
419
687
self.last_checked_ok = datetime.datetime.utcnow()
420
gobject.source_remove(self.disable_initiator_tag)
421
self.disable_initiator_tag = (gobject.timeout_add
422
(self.timeout_milliseconds(),
423
self.disable))
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()
424
706
425
707
def start_checker(self):
426
708
"""Start a new checker subprocess if one is not running.
428
710
If a checker already exists, leave it running and do
429
711
nothing."""
430
712
# The reason for not killing a running checker is that if we
431
# did that, then if a checker (for some reason) started
432
# running slowly and taking more than 'interval' time, the
433
# client would inevitably timeout, since no checker would get
434
# a chance to run to completion. If we instead leave running
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
435
717
# checkers alone, the checker would have to take more time
436
718
# than 'timeout' for the client to be disabled, which is as it
437
719
# should be.
438
720
439
# If a checker exists, make sure it is not a zombie
440
try:
441
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
442
except (AttributeError, OSError), error:
443
if (isinstance(error, OSError)
444
and error.errno != errno.ECHILD):
445
raise error
446
else:
447
if pid:
448
logger.warning(u"Checker was a zombie")
449
gobject.source_remove(self.checker_callback_tag)
450
self.checker_callback(pid, status,
451
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
452
725
# Start a new checker if needed
453
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 }
454
731
try:
455
# In case checker_command has exactly one % operator
456
command = self.checker_command % self.host
457
except TypeError:
458
# Escape attributes for the shell
459
escaped_attrs = dict(
460
(attr,
461
re.escape(unicode(str(getattr(self, attr, u"")),
462
errors=
463
u'replace')))
464
for attr in
465
self.runtime_expansions)
466
467
try:
468
command = self.checker_command % escaped_attrs
469
except TypeError, error:
470
logger.error(u'Could not format string "%s":'
471
u' %s', self.checker_command, error)
472
return True # Try again later
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
473
738
self.current_checker_command = command
474
try:
475
logger.info(u"Starting checker %r for %s",
476
command, self.name)
477
# We don't need to redirect stdout and stderr, since
478
# in normal mode, that is already done by daemon(),
479
# and in debug mode we don't want to. (Stdin is
480
# always replaced by /dev/null.)
481
self.checker = subprocess.Popen(command,
482
close_fds=True,
483
shell=True, cwd=u"/")
484
self.checker_callback_tag = (gobject.child_watch_add
485
(self.checker.pid,
486
self.checker_callback,
487
data=command))
488
# The checker may have completed before the gobject
489
# watch was added. Check for this.
490
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
491
if pid:
492
gobject.source_remove(self.checker_callback_tag)
493
self.checker_callback(pid, status, command)
494
except OSError, error:
495
logger.error(u"Failed to start subprocess: %s",
496
error)
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)
497
764
# Re-run this periodically if run by gobject.timeout_add
498
765
return True
499
766
502
769
if self.checker_callback_tag:
503
770
gobject.source_remove(self.checker_callback_tag)
504
771
self.checker_callback_tag = None
505
if getattr(self, u"checker", None) is None:
772
if getattr(self, "checker", None) is None:
506
773
return
507
logger.debug(u"Stopping checker for %(name)s", vars(self))
508
try:
509
os.kill(self.checker.pid, signal.SIGTERM)
510
#time.sleep(0.5)
511
#if self.checker.poll() is None:
512
# os.kill(self.checker.pid, signal.SIGKILL)
513
except OSError, error:
514
if error.errno != errno.ESRCH: # No such process
515
raise
774
logger.debug("Stopping checker for %(name)s", vars(self))
775
self.checker.terminate()
516
776
self.checker = None
517
777
518
def dbus_service_property(dbus_interface, signature=u"v",
519
access=u"readwrite", byte_arrays=False):
778
779
def dbus_service_property(dbus_interface,
780
signature="v",
781
access="readwrite",
782
byte_arrays=False):
520
783
"""Decorators for marking methods of a DBusObjectWithProperties to
521
784
become properties on the D-Bus.
522
785
529
792
"""
530
793
# Encoding deeply encoded byte arrays is not supported yet by the
531
794
# "Set" method, so we fail early here:
532
if byte_arrays and signature != u"ay":
533
raise ValueError(u"Byte arrays not supported for non-'ay'"
534
u" signature %r" % signature)
795
if byte_arrays and signature != "ay":
796
raise ValueError("Byte arrays not supported for non-'ay'"
797
" signature {!r}".format(signature))
798
535
799
def decorator(func):
536
800
func._dbus_is_property = True
537
801
func._dbus_interface = dbus_interface
538
802
func._dbus_signature = signature
539
803
func._dbus_access = access
540
804
func._dbus_name = func.__name__
541
if func._dbus_name.endswith(u"_dbus_property"):
805
if func._dbus_name.endswith("_dbus_property"):
542
806
func._dbus_name = func._dbus_name[:-14]
543
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
544
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
545
853
return decorator
546
854
547
855
548
856
class DBusPropertyException(dbus.exceptions.DBusException):
549
857
"""A base class for D-Bus property-related exceptions
550
858
"""
551
def __unicode__(self):
552
return unicode(str(self))
859
pass
553
860
554
861
555
862
class DBusPropertyAccessException(DBusPropertyException):
564
871
pass
565
872
566
873
567
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):
568
964
"""A D-Bus object with properties.
569
965
570
966
Classes inheriting from this can use the dbus_service_property
571
967
decorator to expose methods as D-Bus properties. It exposes the
572
968
standard Get(), Set(), and GetAll() methods on the D-Bus.
573
969
"""
574
970
575
@staticmethod
576
def _is_dbus_property(obj):
577
return getattr(obj, u"_dbus_is_property", False)
578
579
def _get_all_dbus_properties(self):
580
"""Returns a generator of (name, attribute) pairs
581
"""
582
return ((prop._dbus_name, prop)
583
for name, prop in
584
inspect.getmembers(self, self._is_dbus_property))
585
586
971
def _get_dbus_property(self, interface_name, property_name):
587
972
"""Returns a bound method if one exists which is a D-Bus
588
973
property with the specified name and interface.
589
974
"""
590
for name in (property_name,
591
property_name + u"_dbus_property"):
592
prop = getattr(self, name, None)
593
if (prop is None
594
or not self._is_dbus_property(prop)
595
or prop._dbus_name != property_name
596
or (interface_name and prop._dbus_interface
597
and interface_name != prop._dbus_interface)):
598
continue
599
return prop
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
600
982
# No such property
601
raise DBusPropertyNotFound(self.dbus_object_path + u":"
602
+ interface_name + u"."
603
+ property_name)
604
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
606
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")
607
998
def Get(self, interface_name, property_name):
608
999
"""Standard D-Bus property Get() method, see D-Bus standard.
609
1000
"""
610
1001
prop = self._get_dbus_property(interface_name, property_name)
611
if prop._dbus_access == u"write":
1002
if prop._dbus_access == "write":
612
1003
raise DBusPropertyAccessException(property_name)
613
1004
value = prop()
614
if not hasattr(value, u"variant_level"):
1005
if not hasattr(value, "variant_level"):
615
1006
return value
616
1007
return type(value)(value, variant_level=value.variant_level+1)
617
1008
618
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1009
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
619
1010
def Set(self, interface_name, property_name, value):
620
1011
"""Standard D-Bus property Set() method, see D-Bus standard.
621
1012
"""
622
1013
prop = self._get_dbus_property(interface_name, property_name)
623
if prop._dbus_access == u"read":
1014
if prop._dbus_access == "read":
624
1015
raise DBusPropertyAccessException(property_name)
625
if prop._dbus_get_args_options[u"byte_arrays"]:
1016
if prop._dbus_get_args_options["byte_arrays"]:
626
1017
# The byte_arrays option is not supported yet on
627
1018
# signatures other than "ay".
628
if prop._dbus_signature != u"ay":
629
raise ValueError
630
value = dbus.ByteArray(''.join(unichr(byte)
631
for byte in value))
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))
632
1025
prop(value)
633
1026
634
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
635
out_signature=u"a{sv}")
1027
@dbus.service.method(dbus.PROPERTIES_IFACE,
1028
in_signature="s",
1029
out_signature="a{sv}")
636
1030
def GetAll(self, interface_name):
637
1031
"""Standard D-Bus property GetAll() method, see D-Bus
638
1032
standard.
639
1033
640
1034
Note: Will not include properties with access="write".
641
1035
"""
642
all = {}
643
for name, prop in self._get_all_dbus_properties():
1036
properties = {}
1037
for name, prop in self._get_all_dbus_things("property"):
644
1038
if (interface_name
645
1039
and interface_name != prop._dbus_interface):
646
1040
# Interface non-empty but did not match
647
1041
continue
648
1042
# Ignore write-only properties
649
if prop._dbus_access == u"write":
1043
if prop._dbus_access == "write":
650
1044
continue
651
1045
value = prop()
652
if not hasattr(value, u"variant_level"):
653
all[name] = value
1046
if not hasattr(value, "variant_level"):
1047
properties[name] = value
654
1048
continue
655
all[name] = type(value)(value, variant_level=
656
value.variant_level+1)
657
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
658
1060
659
1061
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
660
out_signature=u"s",
1062
out_signature="s",
661
1063
path_keyword='object_path',
662
1064
connection_keyword='connection')
663
1065
def Introspect(self, object_path, connection):
664
"""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.
665
1069
"""
666
xmlstring = dbus.service.Object.Introspect(self, object_path,
667
connection)
1070
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1071
object_path,
1072
connection)
668
1073
try:
669
1074
document = xml.dom.minidom.parseString(xmlstring)
1075
670
1076
def make_tag(document, name, prop):
671
e = document.createElement(u"property")
672
e.setAttribute(u"name", name)
673
e.setAttribute(u"type", prop._dbus_signature)
674
e.setAttribute(u"access", prop._dbus_access)
1077
e = document.createElement("property")
1078
e.setAttribute("name", name)
1079
e.setAttribute("type", prop._dbus_signature)
1080
e.setAttribute("access", prop._dbus_access)
675
1081
return e
676
for if_tag in document.getElementsByTagName(u"interface"):
1082
1083
for if_tag in document.getElementsByTagName("interface"):
1084
# Add property tags
677
1085
for tag in (make_tag(document, name, prop)
678
1086
for name, prop
679
in self._get_all_dbus_properties()
1087
in self._get_all_dbus_things("property")
680
1088
if prop._dbus_interface
681
== if_tag.getAttribute(u"name")):
1089
== if_tag.getAttribute("name")):
682
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)
683
1107
# Add the names to the return values for the
684
1108
# "org.freedesktop.DBus.Properties" methods
685
if (if_tag.getAttribute(u"name")
686
== u"org.freedesktop.DBus.Properties"):
687
for cn in if_tag.getElementsByTagName(u"method"):
688
if cn.getAttribute(u"name") == u"Get":
689
for arg in cn.getElementsByTagName(u"arg"):
690
if (arg.getAttribute(u"direction")
691
== u"out"):
692
arg.setAttribute(u"name", u"value")
693
elif cn.getAttribute(u"name") == u"GetAll":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
696
== u"out"):
697
arg.setAttribute(u"name", u"props")
698
xmlstring = document.toxml(u"utf-8")
699
document.unlink()
700
except (AttributeError, xml.dom.DOMException,
701
xml.parsers.expat.ExpatError), error:
702
logger.error(u"Failed to override Introspection method",
703
error)
704
return xmlstring
705
706
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"})
707
1394
class ClientDBus(Client, DBusObjectWithProperties):
708
1395
"""A Client class using D-Bus
709
1396
713
1400
"""
714
1401
715
1402
runtime_expansions = (Client.runtime_expansions
716
+ (u"dbus_object_path",))
1403
+ ("dbus_object_path", ))
1404
1405
_interface = "se.recompile.Mandos.Client"
717
1406
718
1407
# dbus.service.Object doesn't use super(), so we can't either.
719
1408
720
1409
def __init__(self, bus = None, *args, **kwargs):
721
self._approvals_pending = 0
722
1410
self.bus = bus
723
1411
Client.__init__(self, *args, **kwargs)
724
1412
# Only now, when this client is initialized, can it show up on
725
1413
# the D-Bus
726
self.dbus_object_path = (dbus.ObjectPath
727
(u"/clients/"
728
+ 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)
729
1419
DBusObjectWithProperties.__init__(self, self.bus,
730
1420
self.dbus_object_path)
731
732
def _get_approvals_pending(self):
733
return self._approvals_pending
734
def _set_approvals_pending(self, value):
735
old_value = self._approvals_pending
736
self._approvals_pending = value
737
bval = bool(value)
738
if (hasattr(self, "dbus_object_path")
739
and bval is not bool(old_value)):
740
dbus_bool = dbus.Boolean(bval, variant_level=1)
741
self.PropertyChanged(dbus.String(u"ApprovalPending"),
742
dbus_bool)
743
744
approvals_pending = property(_get_approvals_pending,
745
_set_approvals_pending)
746
del _get_approvals_pending, _set_approvals_pending
747
748
@staticmethod
749
def _datetime_to_dbus(dt, variant_level=0):
750
"""Convert a UTC datetime.datetime() to a D-Bus type."""
751
return dbus.String(dt.isoformat(),
752
variant_level=variant_level)
753
754
def enable(self):
755
oldstate = getattr(self, u"enabled", False)
756
r = Client.enable(self)
757
if oldstate != self.enabled:
758
# Emit D-Bus signals
759
self.PropertyChanged(dbus.String(u"Enabled"),
760
dbus.Boolean(True, variant_level=1))
761
self.PropertyChanged(
762
dbus.String(u"LastEnabled"),
763
self._datetime_to_dbus(self.last_enabled,
764
variant_level=1))
765
return r
766
767
def disable(self, quiet = False):
768
oldstate = getattr(self, u"enabled", False)
769
r = Client.disable(self, quiet=quiet)
770
if not quiet and oldstate != self.enabled:
771
# Emit D-Bus signal
772
self.PropertyChanged(dbus.String(u"Enabled"),
773
dbus.Boolean(False, variant_level=1))
774
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
775
1502
776
1503
def __del__(self, *args, **kwargs):
777
1504
try:
778
1505
self.remove_from_connection()
779
1506
except LookupError:
780
1507
pass
781
if hasattr(DBusObjectWithProperties, u"__del__"):
1508
if hasattr(DBusObjectWithProperties, "__del__"):
782
1509
DBusObjectWithProperties.__del__(self, *args, **kwargs)
783
1510
Client.__del__(self, *args, **kwargs)
784
1511
785
def checker_callback(self, pid, condition, command,
786
*args, **kwargs):
787
self.checker_callback_tag = None
788
self.checker = None
789
# Emit D-Bus signal
790
self.PropertyChanged(dbus.String(u"CheckerRunning"),
791
dbus.Boolean(False, variant_level=1))
792
if os.WIFEXITED(condition):
793
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:
794
1519
# Emit D-Bus signal
795
1520
self.CheckerCompleted(dbus.Int16(exitstatus),
796
dbus.Int64(condition),
1521
# This is specific to GNU libC
1522
dbus.Int64(exitstatus << 8),
797
1523
dbus.String(command))
798
1524
else:
799
1525
# Emit D-Bus signal
800
1526
self.CheckerCompleted(dbus.Int16(-1),
801
dbus.Int64(condition),
1527
dbus.Int64(
1528
# This is specific to GNU libC
1529
(exitstatus << 8)
1530
| self.last_checker_signal),
802
1531
dbus.String(command))
803
804
return Client.checker_callback(self, pid, condition, command,
805
*args, **kwargs)
806
807
def checked_ok(self, *args, **kwargs):
808
r = Client.checked_ok(self, *args, **kwargs)
809
# Emit D-Bus signal
810
self.PropertyChanged(
811
dbus.String(u"LastCheckedOK"),
812
(self._datetime_to_dbus(self.last_checked_ok,
813
variant_level=1)))
814
return r
1532
return ret
815
1533
816
1534
def start_checker(self, *args, **kwargs):
817
old_checker = self.checker
818
if self.checker is not None:
819
old_checker_pid = self.checker.pid
820
else:
821
old_checker_pid = None
1535
old_checker_pid = getattr(self.checker, "pid", None)
822
1536
r = Client.start_checker(self, *args, **kwargs)
823
1537
# Only if new checker process was started
824
1538
if (self.checker is not None
825
1539
and old_checker_pid != self.checker.pid):
826
1540
# Emit D-Bus signal
827
1541
self.CheckerStarted(self.current_checker_command)
828
self.PropertyChanged(
829
dbus.String(u"CheckerRunning"),
830
dbus.Boolean(True, variant_level=1))
831
1542
return r
832
1543
833
def stop_checker(self, *args, **kwargs):
834
old_checker = getattr(self, u"checker", None)
835
r = Client.stop_checker(self, *args, **kwargs)
836
if (old_checker is not None
837
and getattr(self, u"checker", None) is None):
838
self.PropertyChanged(dbus.String(u"CheckerRunning"),
839
dbus.Boolean(False, variant_level=1))
840
return r
841
842
1544
def _reset_approved(self):
843
self._approved = None
1545
self.approved = None
844
1546
return False
845
1547
846
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)
847
1552
self.send_changedstate()
848
self._approved = value
849
gobject.timeout_add(self._timedelta_to_milliseconds
850
(self.approval_duration),
851
self._reset_approved)
852
853
1553
854
1554
## D-Bus methods, signals & properties
855
_interface = u"se.bsnet.fukt.Mandos.Client"
1555
1556
## Interfaces
856
1557
857
1558
## Signals
858
1559
859
1560
# CheckerCompleted - signal
860
@dbus.service.signal(_interface, signature=u"nxs")
1561
@dbus.service.signal(_interface, signature="nxs")
861
1562
def CheckerCompleted(self, exitcode, waitstatus, command):
862
1563
"D-Bus signal"
863
1564
pass
864
1565
865
1566
# CheckerStarted - signal
866
@dbus.service.signal(_interface, signature=u"s")
1567
@dbus.service.signal(_interface, signature="s")
867
1568
def CheckerStarted(self, command):
868
1569
"D-Bus signal"
869
1570
pass
870
1571
871
1572
# PropertyChanged - signal
872
@dbus.service.signal(_interface, signature=u"sv")
1573
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1574
@dbus.service.signal(_interface, signature="sv")
873
1575
def PropertyChanged(self, property, value):
874
1576
"D-Bus signal"
875
1577
pass
884
1586
pass
885
1587
886
1588
# Rejected - signal
887
@dbus.service.signal(_interface, signature=u"s")
1589
@dbus.service.signal(_interface, signature="s")
888
1590
def Rejected(self, reason):
889
1591
"D-Bus signal"
890
1592
pass
891
1593
892
1594
# NeedApproval - signal
893
@dbus.service.signal(_interface, signature=u"tb")
1595
@dbus.service.signal(_interface, signature="tb")
894
1596
def NeedApproval(self, timeout, default):
895
1597
"D-Bus signal"
896
pass
1598
return self.need_approval()
897
1599
898
1600
## Methods
899
1601
900
1602
# Approve - method
901
@dbus.service.method(_interface, in_signature=u"b")
1603
@dbus.service.method(_interface, in_signature="b")
902
1604
def Approve(self, value):
903
1605
self.approve(value)
904
1606
905
1607
# CheckedOK - method
906
1608
@dbus.service.method(_interface)
907
1609
def CheckedOK(self):
908
return self.checked_ok()
1610
self.checked_ok()
909
1611
910
1612
# Enable - method
1613
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
911
1614
@dbus.service.method(_interface)
912
1615
def Enable(self):
913
1616
"D-Bus method"
914
1617
self.enable()
915
1618
916
1619
# StartChecker - method
1620
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
917
1621
@dbus.service.method(_interface)
918
1622
def StartChecker(self):
919
1623
"D-Bus method"
920
1624
self.start_checker()
921
1625
922
1626
# Disable - method
1627
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
923
1628
@dbus.service.method(_interface)
924
1629
def Disable(self):
925
1630
"D-Bus method"
926
1631
self.disable()
927
1632
928
1633
# StopChecker - method
1634
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
929
1635
@dbus.service.method(_interface)
930
1636
def StopChecker(self):
931
1637
self.stop_checker()
933
1639
## Properties
934
1640
935
1641
# ApprovalPending - property
936
@dbus_service_property(_interface, signature=u"b", access=u"read")
1642
@dbus_service_property(_interface, signature="b", access="read")
937
1643
def ApprovalPending_dbus_property(self):
938
1644
return dbus.Boolean(bool(self.approvals_pending))
939
1645
940
1646
# ApprovedByDefault - property
941
@dbus_service_property(_interface, signature=u"b",
942
access=u"readwrite")
1647
@dbus_service_property(_interface,
1648
signature="b",
1649
access="readwrite")
943
1650
def ApprovedByDefault_dbus_property(self, value=None):
944
1651
if value is None: # get
945
1652
return dbus.Boolean(self.approved_by_default)
946
1653
self.approved_by_default = bool(value)
947
# Emit D-Bus signal
948
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
949
dbus.Boolean(value, variant_level=1))
950
1654
951
1655
# ApprovalDelay - property
952
@dbus_service_property(_interface, signature=u"t",
953
access=u"readwrite")
1656
@dbus_service_property(_interface,
1657
signature="t",
1658
access="readwrite")
954
1659
def ApprovalDelay_dbus_property(self, value=None):
955
1660
if value is None: # get
956
return dbus.UInt64(self.approval_delay_milliseconds())
1661
return dbus.UInt64(self.approval_delay.total_seconds()
1662
* 1000)
957
1663
self.approval_delay = datetime.timedelta(0, 0, 0, value)
958
# Emit D-Bus signal
959
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
960
dbus.UInt64(value, variant_level=1))
961
1664
962
1665
# ApprovalDuration - property
963
@dbus_service_property(_interface, signature=u"t",
964
access=u"readwrite")
1666
@dbus_service_property(_interface,
1667
signature="t",
1668
access="readwrite")
965
1669
def ApprovalDuration_dbus_property(self, value=None):
966
1670
if value is None: # get
967
return dbus.UInt64(self._timedelta_to_milliseconds(
968
self.approval_duration))
1671
return dbus.UInt64(self.approval_duration.total_seconds()
1672
* 1000)
969
1673
self.approval_duration = datetime.timedelta(0, 0, 0, value)
970
# Emit D-Bus signal
971
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
972
dbus.UInt64(value, variant_level=1))
973
1674
974
1675
# Name - property
975
@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")
976
1679
def Name_dbus_property(self):
977
1680
return dbus.String(self.name)
978
1681
979
1682
# Fingerprint - property
980
@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")
981
1686
def Fingerprint_dbus_property(self):
982
1687
return dbus.String(self.fingerprint)
983
1688
984
1689
# Host - property
985
@dbus_service_property(_interface, signature=u"s",
986
access=u"readwrite")
1690
@dbus_service_property(_interface,
1691
signature="s",
1692
access="readwrite")
987
1693
def Host_dbus_property(self, value=None):
988
1694
if value is None: # get
989
1695
return dbus.String(self.host)
990
self.host = value
991
# Emit D-Bus signal
992
self.PropertyChanged(dbus.String(u"Host"),
993
dbus.String(value, variant_level=1))
1696
self.host = str(value)
994
1697
995
1698
# Created - property
996
@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")
997
1702
def Created_dbus_property(self):
998
return dbus.String(self._datetime_to_dbus(self.created))
1703
return datetime_to_dbus(self.created)
999
1704
1000
1705
# LastEnabled - property
1001
@dbus_service_property(_interface, signature=u"s", access=u"read")
1706
@dbus_service_property(_interface, signature="s", access="read")
1002
1707
def LastEnabled_dbus_property(self):
1003
if self.last_enabled is None:
1004
return dbus.String(u"")
1005
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1708
return datetime_to_dbus(self.last_enabled)
1006
1709
1007
1710
# Enabled - property
1008
@dbus_service_property(_interface, signature=u"b",
1009
access=u"readwrite")
1711
@dbus_service_property(_interface,
1712
signature="b",
1713
access="readwrite")
1010
1714
def Enabled_dbus_property(self, value=None):
1011
1715
if value is None: # get
1012
1716
return dbus.Boolean(self.enabled)
1016
1720
self.disable()
1017
1721
1018
1722
# LastCheckedOK - property
1019
@dbus_service_property(_interface, signature=u"s",
1020
access=u"readwrite")
1723
@dbus_service_property(_interface,
1724
signature="s",
1725
access="readwrite")
1021
1726
def LastCheckedOK_dbus_property(self, value=None):
1022
1727
if value is not None:
1023
1728
self.checked_ok()
1024
1729
return
1025
if self.last_checked_ok is None:
1026
return dbus.String(u"")
1027
return dbus.String(self._datetime_to_dbus(self
1028
.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)
1029
1746
1030
1747
# Timeout - property
1031
@dbus_service_property(_interface, signature=u"t",
1032
access=u"readwrite")
1748
@dbus_service_property(_interface,
1749
signature="t",
1750
access="readwrite")
1033
1751
def Timeout_dbus_property(self, value=None):
1034
1752
if value is None: # get
1035
return dbus.UInt64(self.timeout_milliseconds())
1753
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1754
old_timeout = self.timeout
1036
1755
self.timeout = datetime.timedelta(0, 0, 0, value)
1037
# Emit D-Bus signal
1038
self.PropertyChanged(dbus.String(u"Timeout"),
1039
dbus.UInt64(value, variant_level=1))
1040
if getattr(self, u"disable_initiator_tag", None) is None:
1041
return
1042
# Reschedule timeout
1043
gobject.source_remove(self.disable_initiator_tag)
1044
self.disable_initiator_tag = None
1045
time_to_die = (self.
1046
_timedelta_to_milliseconds((self
1047
.last_checked_ok
1048
+ self.timeout)
1049
- datetime.datetime
1050
.utcnow()))
1051
if time_to_die <= 0:
1052
# The timeout has passed
1053
self.disable()
1054
else:
1055
self.disable_initiator_tag = (gobject.timeout_add
1056
(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)
1057
1781
1058
1782
# Interval - property
1059
@dbus_service_property(_interface, signature=u"t",
1060
access=u"readwrite")
1783
@dbus_service_property(_interface,
1784
signature="t",
1785
access="readwrite")
1061
1786
def Interval_dbus_property(self, value=None):
1062
1787
if value is None: # get
1063
return dbus.UInt64(self.interval_milliseconds())
1788
return dbus.UInt64(self.interval.total_seconds() * 1000)
1064
1789
self.interval = datetime.timedelta(0, 0, 0, value)
1065
# Emit D-Bus signal
1066
self.PropertyChanged(dbus.String(u"Interval"),
1067
dbus.UInt64(value, variant_level=1))
1068
if getattr(self, u"checker_initiator_tag", None) is None:
1790
if getattr(self, "checker_initiator_tag", None) is None:
1069
1791
return
1070
# Reschedule checker run
1071
gobject.source_remove(self.checker_initiator_tag)
1072
self.checker_initiator_tag = (gobject.timeout_add
1073
(value, self.start_checker))
1074
self.start_checker() # Start one now, too
1075
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
1076
1799
# Checker - property
1077
@dbus_service_property(_interface, signature=u"s",
1078
access=u"readwrite")
1800
@dbus_service_property(_interface,
1801
signature="s",
1802
access="readwrite")
1079
1803
def Checker_dbus_property(self, value=None):
1080
1804
if value is None: # get
1081
1805
return dbus.String(self.checker_command)
1082
self.checker_command = value
1083
# Emit D-Bus signal
1084
self.PropertyChanged(dbus.String(u"Checker"),
1085
dbus.String(self.checker_command,
1086
variant_level=1))
1806
self.checker_command = str(value)
1087
1807
1088
1808
# CheckerRunning - property
1089
@dbus_service_property(_interface, signature=u"b",
1090
access=u"readwrite")
1809
@dbus_service_property(_interface,
1810
signature="b",
1811
access="readwrite")
1091
1812
def CheckerRunning_dbus_property(self, value=None):
1092
1813
if value is None: # get
1093
1814
return dbus.Boolean(self.checker is not None)
1097
1818
self.stop_checker()
1098
1819
1099
1820
# ObjectPath - property
1100
@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")
1101
1825
def ObjectPath_dbus_property(self):
1102
1826
return self.dbus_object_path # is already a dbus.ObjectPath
1103
1827
1104
1828
# Secret = property
1105
@dbus_service_property(_interface, signature=u"ay",
1106
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)
1107
1836
def Secret_dbus_property(self, value):
1108
self.secret = str(value)
1837
self.secret = bytes(value)
1109
1838
1110
1839
del _interface
1111
1840
1115
1844
self._pipe = child_pipe
1116
1845
self._pipe.send(('init', fpr, address))
1117
1846
if not self._pipe.recv():
1118
raise KeyError()
1119
1847
raise KeyError(fpr)
1848
1120
1849
def __getattribute__(self, name):
1121
if(name == '_pipe'):
1850
if name == '_pipe':
1122
1851
return super(ProxyClient, self).__getattribute__(name)
1123
1852
self._pipe.send(('getattr', name))
1124
1853
data = self._pipe.recv()
1125
1854
if data[0] == 'data':
1126
1855
return data[1]
1127
1856
if data[0] == 'function':
1857
1128
1858
def func(*args, **kwargs):
1129
1859
self._pipe.send(('funcall', name, args, kwargs))
1130
1860
return self._pipe.recv()[1]
1861
1131
1862
return func
1132
1863
1133
1864
def __setattr__(self, name, value):
1134
if(name == '_pipe'):
1865
if name == '_pipe':
1135
1866
return super(ProxyClient, self).__setattr__(name, value)
1136
1867
self._pipe.send(('setattr', name, value))
1137
1868
1144
1875
1145
1876
def handle(self):
1146
1877
with contextlib.closing(self.server.child_pipe) as child_pipe:
1147
logger.info(u"TCP connection from: %s",
1148
unicode(self.client_address))
1149
logger.debug(u"Pipe FD: %d",
1878
logger.info("TCP connection from: %s",
1879
str(self.client_address))
1880
logger.debug("Pipe FD: %d",
1150
1881
self.server.child_pipe.fileno())
1151
1152
session = (gnutls.connection
1153
.ClientSession(self.request,
1154
gnutls.connection
1155
.X509Credentials()))
1156
1882
1883
session = gnutls.connection.ClientSession(
1884
self.request, gnutls.connection .X509Credentials())
1885
1157
1886
# Note: gnutls.connection.X509Credentials is really a
1158
1887
# generic GnuTLS certificate credentials object so long as
1159
1888
# no X.509 keys are added to it. Therefore, we can use it
1160
1889
# here despite using OpenPGP certificates.
1161
1162
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1163
# u"+AES-256-CBC", u"+SHA1",
1164
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1165
# u"+DHE-DSS"))
1890
1891
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1892
# "+AES-256-CBC", "+SHA1",
1893
# "+COMP-NULL", "+CTYPE-OPENPGP",
1894
# "+DHE-DSS"))
1166
1895
# Use a fallback default, since this MUST be set.
1167
1896
priority = self.server.gnutls_priority
1168
1897
if priority is None:
1169
priority = u"NORMAL"
1170
(gnutls.library.functions
1171
.gnutls_priority_set_direct(session._c_object,
1172
priority, None))
1173
1898
priority = "NORMAL"
1899
gnutls.library.functions.gnutls_priority_set_direct(
1900
session._c_object, priority, None)
1901
1174
1902
# Start communication using the Mandos protocol
1175
1903
# Get protocol number
1176
1904
line = self.request.makefile().readline()
1177
logger.debug(u"Protocol version: %r", line)
1905
logger.debug("Protocol version: %r", line)
1178
1906
try:
1179
1907
if int(line.strip().split()[0]) > 1:
1180
raise RuntimeError
1181
except (ValueError, IndexError, RuntimeError), error:
1182
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)
1183
1911
return
1184
1912
1185
1913
# Start GnuTLS connection
1186
1914
try:
1187
1915
session.handshake()
1188
except gnutls.errors.GNUTLSError, error:
1189
logger.warning(u"Handshake failed: %s", error)
1916
except gnutls.errors.GNUTLSError as error:
1917
logger.warning("Handshake failed: %s", error)
1190
1918
# Do not run session.bye() here: the session is not
1191
1919
# established. Just abandon the request.
1192
1920
return
1193
logger.debug(u"Handshake succeeded")
1194
1921
logger.debug("Handshake succeeded")
1922
1195
1923
approval_required = False
1196
1924
try:
1197
1925
try:
1198
fpr = self.fingerprint(self.peer_certificate
1199
(session))
1200
except (TypeError, gnutls.errors.GNUTLSError), error:
1201
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)
1202
1931
return
1203
logger.debug(u"Fingerprint: %s", fpr)
1204
1932
logger.debug("Fingerprint: %s", fpr)
1933
1205
1934
try:
1206
1935
client = ProxyClient(child_pipe, fpr,
1207
1936
self.client_address)
1215
1944
1216
1945
while True:
1217
1946
if not client.enabled:
1218
logger.warning(u"Client %s is disabled",
1219
client.name)
1947
logger.info("Client %s is disabled",
1948
client.name)
1220
1949
if self.server.use_dbus:
1221
1950
# Emit D-Bus signal
1222
client.Rejected("Disabled")
1951
client.Rejected("Disabled")
1223
1952
return
1224
1953
1225
if client._approved or not client.approval_delay:
1954
if client.approved or not client.approval_delay:
1226
1955
#We are approved or approval is disabled
1227
1956
break
1228
elif client._approved is None:
1229
logger.info(u"Client %s needs approval",
1957
elif client.approved is None:
1958
logger.info("Client %s needs approval",
1230
1959
client.name)
1231
1960
if self.server.use_dbus:
1232
1961
# Emit D-Bus signal
1233
1962
client.NeedApproval(
1234
client.approval_delay_milliseconds(),
1235
client.approved_by_default)
1963
client.approval_delay.total_seconds()
1964
* 1000, client.approved_by_default)
1236
1965
else:
1237
logger.warning(u"Client %s was not approved",
1966
logger.warning("Client %s was not approved",
1238
1967
client.name)
1239
1968
if self.server.use_dbus:
1240
1969
# Emit D-Bus signal
1242
1971
return
1243
1972
1244
1973
#wait until timeout or approved
1245
#x = float(client._timedelta_to_milliseconds(delay))
1246
1974
time = datetime.datetime.now()
1247
1975
client.changedstate.acquire()
1248
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1976
client.changedstate.wait(delay.total_seconds())
1249
1977
client.changedstate.release()
1250
1978
time2 = datetime.datetime.now()
1251
1979
if (time2 - time) >= delay:
1266
1994
while sent_size < len(client.secret):
1267
1995
try:
1268
1996
sent = session.send(client.secret[sent_size:])
1269
except (gnutls.errors.GNUTLSError), error:
1270
logger.warning("gnutls send failed")
1997
except gnutls.errors.GNUTLSError as error:
1998
logger.warning("gnutls send failed",
1999
exc_info=error)
1271
2000
return
1272
logger.debug(u"Sent: %d, remaining: %d",
1273
sent, len(client.secret)
1274
- (sent_size + sent))
2001
logger.debug("Sent: %d, remaining: %d", sent,
2002
len(client.secret) - (sent_size
2003
+ sent))
1275
2004
sent_size += sent
1276
1277
logger.info(u"Sending secret to %s", client.name)
1278
# bump the timeout as if seen
1279
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)
1280
2009
if self.server.use_dbus:
1281
2010
# Emit D-Bus signal
1282
2011
client.GotSecret()
1286
2015
client.approvals_pending -= 1
1287
2016
try:
1288
2017
session.bye()
1289
except (gnutls.errors.GNUTLSError), error:
1290
logger.warning("GnuTLS bye failed")
2018
except gnutls.errors.GNUTLSError as error:
2019
logger.warning("GnuTLS bye failed",
2020
exc_info=error)
1291
2021
1292
2022
@staticmethod
1293
2023
def peer_certificate(session):
1294
2024
"Return the peer's OpenPGP certificate as a bytestring"
1295
2025
# If not an OpenPGP certificate...
1296
if (gnutls.library.functions
1297
.gnutls_certificate_type_get(session._c_object)
2026
if (gnutls.library.functions.gnutls_certificate_type_get(
2027
session._c_object)
1298
2028
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1299
2029
# ...do the normal thing
1300
2030
return session.peer_certificate
1303
2033
.gnutls_certificate_get_peers
1304
2034
(session._c_object, ctypes.byref(list_size)))
1305
2035
if not bool(cert_list) and list_size.value != 0:
1306
raise gnutls.errors.GNUTLSError(u"error getting peer"
1307
u" certificate")
2036
raise gnutls.errors.GNUTLSError("error getting peer"
2037
" certificate")
1308
2038
if list_size.value == 0:
1309
2039
return None
1310
2040
cert = cert_list[0]
1314
2044
def fingerprint(openpgp):
1315
2045
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1316
2046
# New GnuTLS "datum" with the OpenPGP public key
1317
datum = (gnutls.library.types
1318
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1319
ctypes.POINTER
1320
(ctypes.c_ubyte)),
1321
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)))
1322
2051
# New empty GnuTLS certificate
1323
2052
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1324
(gnutls.library.functions
1325
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2053
gnutls.library.functions.gnutls_openpgp_crt_init(
2054
ctypes.byref(crt))
1326
2055
# Import the OpenPGP public key into the certificate
1327
(gnutls.library.functions
1328
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1329
gnutls.library.constants
1330
.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)
1331
2059
# Verify the self signature in the key
1332
2060
crtverify = ctypes.c_uint()
1333
(gnutls.library.functions
1334
.gnutls_openpgp_crt_verify_self(crt, 0,
1335
ctypes.byref(crtverify)))
2061
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
2062
crt, 0, ctypes.byref(crtverify))
1336
2063
if crtverify.value != 0:
1337
2064
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1338
raise (gnutls.errors.CertificateSecurityError
1339
(u"Verify failed"))
2065
raise gnutls.errors.CertificateSecurityError(
2066
"Verify failed")
1340
2067
# New buffer for the fingerprint
1341
2068
buf = ctypes.create_string_buffer(20)
1342
2069
buf_len = ctypes.c_size_t()
1343
2070
# Get the fingerprint from the certificate into the buffer
1344
(gnutls.library.functions
1345
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1346
ctypes.byref(buf_len)))
2071
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
2072
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1347
2073
# Deinit the certificate
1348
2074
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1349
2075
# Convert the buffer to a Python bytestring
1350
2076
fpr = ctypes.string_at(buf, buf_len.value)
1351
2077
# Convert the bytestring to hexadecimal notation
1352
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2078
hex_fpr = binascii.hexlify(fpr).upper()
1353
2079
return hex_fpr
1354
2080
1355
2081
1356
2082
class MultiprocessingMixIn(object):
1357
2083
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2084
1358
2085
def sub_process_main(self, request, address):
1359
2086
try:
1360
2087
self.finish_request(request, address)
1361
except:
2088
except Exception:
1362
2089
self.handle_error(request, address)
1363
2090
self.close_request(request)
1364
2091
1365
2092
def process_request(self, request, address):
1366
2093
"""Start a new process to process the request."""
1367
multiprocessing.Process(target = self.sub_process_main,
1368
args = (request, address)).start()
2094
proc = multiprocessing.Process(target = self.sub_process_main,
2095
args = (request, address))
2096
proc.start()
2097
return proc
2098
1369
2099
1370
2100
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1371
2101
""" adds a pipe to the MixIn """
2102
1372
2103
def process_request(self, request, client_address):
1373
2104
"""Overrides and wraps the original process_request().
1374
2105
1375
2106
This function creates a new pipe in self.pipe
1376
2107
"""
1377
2108
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1378
1379
super(MultiprocessingMixInWithPipe,
1380
self).process_request(request, client_address)
2109
2110
proc = MultiprocessingMixIn.process_request(self, request,
2111
client_address)
1381
2112
self.child_pipe.close()
1382
self.add_pipe(parent_pipe)
1383
1384
def add_pipe(self, parent_pipe):
2113
self.add_pipe(parent_pipe, proc)
2114
2115
def add_pipe(self, parent_pipe, proc):
1385
2116
"""Dummy function; override as necessary"""
1386
pass
2117
raise NotImplementedError()
2118
1387
2119
1388
2120
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1389
2121
socketserver.TCPServer, object):
1394
2126
interface: None or a network interface name (string)
1395
2127
use_ipv6: Boolean; to use IPv6 or not
1396
2128
"""
2129
1397
2130
def __init__(self, server_address, RequestHandlerClass,
1398
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
"""
1399
2137
self.interface = interface
1400
2138
if use_ipv6:
1401
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.
1402
2166
socketserver.TCPServer.__init__(self, server_address,
1403
2167
RequestHandlerClass)
2168
1404
2169
def server_bind(self):
1405
2170
"""This overrides the normal server_bind() function
1406
2171
to bind to an interface if one was specified, and also NOT to
1407
2172
bind to an address or port if they were not specified."""
1408
2173
if self.interface is not None:
1409
2174
if SO_BINDTODEVICE is None:
1410
logger.error(u"SO_BINDTODEVICE does not exist;"
1411
u" cannot bind to interface %s",
2175
logger.error("SO_BINDTODEVICE does not exist;"
2176
" cannot bind to interface %s",
1412
2177
self.interface)
1413
2178
else:
1414
2179
try:
1415
self.socket.setsockopt(socket.SOL_SOCKET,
1416
SO_BINDTODEVICE,
1417
str(self.interface
1418
+ u'\0'))
1419
except socket.error, error:
1420
if error[0] == errno.EPERM:
1421
logger.error(u"No permission to"
1422
u" bind to interface %s",
1423
self.interface)
1424
elif error[0] == errno.ENOPROTOOPT:
1425
logger.error(u"SO_BINDTODEVICE not available;"
1426
u" cannot bind to interface %s",
1427
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)
1428
2194
else:
1429
2195
raise
1430
2196
# Only bind(2) the socket if we really need to.
1431
2197
if self.server_address[0] or self.server_address[1]:
1432
2198
if not self.server_address[0]:
1433
2199
if self.address_family == socket.AF_INET6:
1434
any_address = u"::" # in6addr_any
2200
any_address = "::" # in6addr_any
1435
2201
else:
1436
any_address = socket.INADDR_ANY
2202
any_address = "0.0.0.0" # INADDR_ANY
1437
2203
self.server_address = (any_address,
1438
2204
self.server_address[1])
1439
2205
elif not self.server_address[1]:
1440
self.server_address = (self.server_address[0],
1441
0)
2206
self.server_address = (self.server_address[0], 0)
1442
2207
# if self.interface:
1443
2208
# self.server_address = (self.server_address[0],
1444
2209
# 0, # port
1458
2223
1459
2224
Assumes a gobject.MainLoop event loop.
1460
2225
"""
2226
1461
2227
def __init__(self, server_address, RequestHandlerClass,
1462
interface=None, use_ipv6=True, clients=None,
1463
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):
1464
2234
self.enabled = False
1465
2235
self.clients = clients
1466
2236
if self.clients is None:
1467
self.clients = set()
2237
self.clients = {}
1468
2238
self.use_dbus = use_dbus
1469
2239
self.gnutls_priority = gnutls_priority
1470
2240
IPv6_TCPServer.__init__(self, server_address,
1471
2241
RequestHandlerClass,
1472
2242
interface = interface,
1473
use_ipv6 = use_ipv6)
2243
use_ipv6 = use_ipv6,
2244
socketfd = socketfd)
2245
1474
2246
def server_activate(self):
1475
2247
if self.enabled:
1476
2248
return socketserver.TCPServer.server_activate(self)
2249
1477
2250
def enable(self):
1478
2251
self.enabled = True
1479
def add_pipe(self, parent_pipe):
2252
2253
def add_pipe(self, parent_pipe, proc):
1480
2254
# Call "handle_ipc" for both data and EOF events
1481
gobject.io_add_watch(parent_pipe.fileno(),
1482
gobject.IO_IN | gobject.IO_HUP,
1483
functools.partial(self.handle_ipc,
1484
parent_pipe = parent_pipe))
1485
1486
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,
1487
2265
client_object=None):
1488
condition_names = {
1489
gobject.IO_IN: u"IN", # There is data to read.
1490
gobject.IO_OUT: u"OUT", # Data can be written (without
1491
# blocking).
1492
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1493
gobject.IO_ERR: u"ERR", # Error condition.
1494
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1495
# broken, usually for pipes and
1496
# sockets).
1497
}
1498
conditions_string = ' | '.join(name
1499
for cond, name in
1500
condition_names.iteritems()
1501
if cond & condition)
1502
# error or the other end of multiprocessing.Pipe has closed
1503
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()
1504
2270
return False
1505
2271
1506
2272
# Read a request from the child
1511
2277
fpr = request[1]
1512
2278
address = request[2]
1513
2279
1514
for c in self.clients:
2280
for c in self.clients.itervalues():
1515
2281
if c.fingerprint == fpr:
1516
2282
client = c
1517
2283
break
1518
2284
else:
1519
logger.warning(u"Client not found for fingerprint: %s, ad"
1520
u"dress: %s", fpr, address)
2285
logger.info("Client not found for fingerprint: %s, ad"
2286
"dress: %s", fpr, address)
1521
2287
if self.use_dbus:
1522
2288
# Emit D-Bus signal
1523
mandos_dbus_service.ClientNotFound(fpr, address)
2289
mandos_dbus_service.ClientNotFound(fpr,
2290
address[0])
1524
2291
parent_pipe.send(False)
1525
2292
return False
1526
2293
1527
gobject.io_add_watch(parent_pipe.fileno(),
1528
gobject.IO_IN | gobject.IO_HUP,
1529
functools.partial(self.handle_ipc,
1530
parent_pipe = parent_pipe,
1531
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))
1532
2301
parent_pipe.send(True)
1533
# 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
1534
2304
return False
1535
2305
if command == 'funcall':
1536
2306
funcname = request[1]
1537
2307
args = request[2]
1538
2308
kwargs = request[3]
1539
2309
1540
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1541
2310
parent_pipe.send(('data', getattr(client_object,
2311
funcname)(*args,
2312
**kwargs)))
2313
1542
2314
if command == 'getattr':
1543
2315
attrname = request[1]
1544
if callable(client_object.__getattribute__(attrname)):
1545
parent_pipe.send(('function',))
2316
if isinstance(client_object.__getattribute__(attrname),
2317
collections.Callable):
2318
parent_pipe.send(('function', ))
1546
2319
else:
1547
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2320
parent_pipe.send((
2321
'data', client_object.__getattribute__(attrname)))
1548
2322
1549
2323
if command == 'setattr':
1550
2324
attrname = request[1]
1551
2325
value = request[2]
1552
2326
setattr(client_object, attrname, value)
1553
2327
1554
2328
return True
1555
2329
1556
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
1557
2427
def string_to_delta(interval):
1558
2428
"""Parse a string and return a datetime.timedelta
1559
2429
1560
>>> string_to_delta(u'7d')
2430
>>> string_to_delta('7d')
1561
2431
datetime.timedelta(7)
1562
>>> string_to_delta(u'60s')
2432
>>> string_to_delta('60s')
1563
2433
datetime.timedelta(0, 60)
1564
>>> string_to_delta(u'60m')
2434
>>> string_to_delta('60m')
1565
2435
datetime.timedelta(0, 3600)
1566
>>> string_to_delta(u'24h')
2436
>>> string_to_delta('24h')
1567
2437
datetime.timedelta(1)
1568
>>> string_to_delta(u'1w')
2438
>>> string_to_delta('1w')
1569
2439
datetime.timedelta(7)
1570
>>> string_to_delta(u'5m 30s')
2440
>>> string_to_delta('5m 30s')
1571
2441
datetime.timedelta(0, 330)
1572
2442
"""
2443
2444
try:
2445
return rfc3339_duration_to_delta(interval)
2446
except ValueError:
2447
pass
2448
1573
2449
timevalue = datetime.timedelta(0)
1574
2450
for s in interval.split():
1575
2451
try:
1576
suffix = unicode(s[-1])
2452
suffix = s[-1]
1577
2453
value = int(s[:-1])
1578
if suffix == u"d":
2454
if suffix == "d":
1579
2455
delta = datetime.timedelta(value)
1580
elif suffix == u"s":
2456
elif suffix == "s":
1581
2457
delta = datetime.timedelta(0, value)
1582
elif suffix == u"m":
2458
elif suffix == "m":
1583
2459
delta = datetime.timedelta(0, 0, 0, 0, value)
1584
elif suffix == u"h":
2460
elif suffix == "h":
1585
2461
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1586
elif suffix == u"w":
2462
elif suffix == "w":
1587
2463
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1588
2464
else:
1589
raise ValueError(u"Unknown suffix %r" % suffix)
1590
except (ValueError, IndexError), e:
1591
raise ValueError(e.message)
2465
raise ValueError("Unknown suffix {!r}".format(suffix))
2466
except IndexError as e:
2467
raise ValueError(*(e.args))
1592
2468
timevalue += delta
1593
2469
return timevalue
1594
2470
1595
2471
1596
def if_nametoindex(interface):
1597
"""Call the C function if_nametoindex(), or equivalent
1598
1599
Note: This function cannot accept a unicode string."""
1600
global if_nametoindex
1601
try:
1602
if_nametoindex = (ctypes.cdll.LoadLibrary
1603
(ctypes.util.find_library(u"c"))
1604
.if_nametoindex)
1605
except (OSError, AttributeError):
1606
logger.warning(u"Doing if_nametoindex the hard way")
1607
def if_nametoindex(interface):
1608
"Get an interface index the hard way, i.e. using fcntl()"
1609
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1610
with contextlib.closing(socket.socket()) as s:
1611
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1612
struct.pack(str(u"16s16x"),
1613
interface))
1614
interface_index = struct.unpack(str(u"I"),
1615
ifreq[16:20])[0]
1616
return interface_index
1617
return if_nametoindex(interface)
1618
1619
1620
2472
def daemon(nochdir = False, noclose = False):
1621
2473
"""See daemon(3). Standard BSD Unix function.
1622
2474
1625
2477
sys.exit()
1626
2478
os.setsid()
1627
2479
if not nochdir:
1628
os.chdir(u"/")
2480
os.chdir("/")
1629
2481
if os.fork():
1630
2482
sys.exit()
1631
2483
if not noclose:
1632
2484
# Close all standard open file descriptors
1633
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2485
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1634
2486
if not stat.S_ISCHR(os.fstat(null).st_mode):
1635
2487
raise OSError(errno.ENODEV,
1636
u"%s not a character device"
1637
% os.path.devnull)
2488
"{} not a character device"
2489
.format(os.devnull))
1638
2490
os.dup2(null, sys.stdin.fileno())
1639
2491
os.dup2(null, sys.stdout.fileno())
1640
2492
os.dup2(null, sys.stderr.fileno())
1647
2499
##################################################################
1648
2500
# Parsing of options, both command line and config file
1649
2501
1650
parser = optparse.OptionParser(version = "%%prog %s" % version)
1651
parser.add_option("-i", u"--interface", type=u"string",
1652
metavar="IF", help=u"Bind to interface IF")
1653
parser.add_option("-a", u"--address", type=u"string",
1654
help=u"Address to listen for requests on")
1655
parser.add_option("-p", u"--port", type=u"int",
1656
help=u"Port number to receive requests on")
1657
parser.add_option("--check", action=u"store_true",
1658
help=u"Run self-test")
1659
parser.add_option("--debug", action=u"store_true",
1660
help=u"Debug mode; run in foreground and log to"
1661
u" terminal")
1662
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1663
help=u"Debug level for stdout output")
1664
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1665
u" priority string (see GnuTLS documentation)")
1666
parser.add_option("--servicename", type=u"string",
1667
metavar=u"NAME", help=u"Zeroconf service name")
1668
parser.add_option("--configdir", type=u"string",
1669
default=u"/etc/mandos", metavar=u"DIR",
1670
help=u"Directory to search for configuration"
1671
u" files")
1672
parser.add_option("--no-dbus", action=u"store_false",
1673
dest=u"use_dbus", help=u"Do not provide D-Bus"
1674
u" system bus interface")
1675
parser.add_option("--no-ipv6", action=u"store_false",
1676
dest=u"use_ipv6", help=u"Do not use IPv6")
1677
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()
1678
2548
1679
2549
if options.check:
1680
2550
import doctest
1681
doctest.testmod()
1682
sys.exit()
2551
fail_count, test_count = doctest.testmod()
2552
sys.exit(os.EX_OK if fail_count == 0 else 1)
1683
2553
1684
2554
# Default values for config file for server-global settings
1685
server_defaults = { u"interface": u"",
1686
u"address": u"",
1687
u"port": u"",
1688
u"debug": u"False",
1689
u"priority":
1690
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1691
u"servicename": u"Mandos",
1692
u"use_dbus": u"True",
1693
u"use_ipv6": u"True",
1694
u"debuglevel": u"",
1695
}
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
}
1696
2572
1697
2573
# Parse config file for server-global settings
1698
2574
server_config = configparser.SafeConfigParser(server_defaults)
1699
2575
del server_defaults
1700
server_config.read(os.path.join(options.configdir,
1701
u"mandos.conf"))
2576
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1702
2577
# Convert the SafeConfigParser object to a dict
1703
2578
server_settings = server_config.defaults()
1704
2579
# Use the appropriate methods on the non-string config options
1705
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1706
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",
1707
2582
option)
1708
2583
if server_settings["port"]:
1709
server_settings["port"] = server_config.getint(u"DEFAULT",
1710
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"])
1711
2595
del server_config
1712
2596
1713
2597
# Override the settings from the config file with command line
1714
2598
# options, if set.
1715
for option in (u"interface", u"address", u"port", u"debug",
1716
u"priority", u"servicename", u"configdir",
1717
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"):
1718
2603
value = getattr(options, option)
1719
2604
if value is not None:
1720
2605
server_settings[option] = value
1721
2606
del options
1722
2607
# Force all strings to be unicode
1723
2608
for option in server_settings.keys():
1724
if type(server_settings[option]) is str:
1725
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
1726
2619
# Now we have our good server settings in "server_settings"
1727
2620
1728
2621
##################################################################
1729
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
1730
2628
# For convenience
1731
debug = server_settings[u"debug"]
1732
debuglevel = server_settings[u"debuglevel"]
1733
use_dbus = server_settings[u"use_dbus"]
1734
use_ipv6 = server_settings[u"use_ipv6"]
1735
1736
if server_settings[u"servicename"] != u"Mandos":
1737
syslogger.setFormatter(logging.Formatter
1738
(u'Mandos (%s) [%%(process)d]:'
1739
u' %%(levelname)s: %%(message)s'
1740
% 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"])))
1741
2652
1742
2653
# Parse config file with clients
1743
client_defaults = { u"timeout": u"1h",
1744
u"interval": u"5m",
1745
u"checker": u"fping -q -- %%(host)s",
1746
u"host": u"",
1747
u"approval_delay": u"0s",
1748
u"approval_duration": u"1s",
1749
}
1750
client_config = configparser.SafeConfigParser(client_defaults)
1751
client_config.read(os.path.join(server_settings[u"configdir"],
1752
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"))
1753
2658
1754
2659
global mandos_dbus_service
1755
2660
mandos_dbus_service = None
1756
2661
1757
tcp_server = MandosServer((server_settings[u"address"],
1758
server_settings[u"port"]),
1759
ClientHandler,
1760
interface=(server_settings[u"interface"]
1761
or None),
1762
use_ipv6=use_ipv6,
1763
gnutls_priority=
1764
server_settings[u"priority"],
1765
use_dbus=use_dbus)
1766
if not debug:
1767
pidfilename = u"/var/run/mandos.pid"
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
1768
2678
try:
1769
pidfile = open(pidfilename, u"w")
1770
except IOError:
1771
logger.error(u"Could not open file %r", pidfilename)
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)
1772
2683
1773
try:
1774
uid = pwd.getpwnam(u"_mandos").pw_uid
1775
gid = pwd.getpwnam(u"_mandos").pw_gid
1776
except KeyError:
2684
for name in ("_mandos", "mandos", "nobody"):
1777
2685
try:
1778
uid = pwd.getpwnam(u"mandos").pw_uid
1779
gid = pwd.getpwnam(u"mandos").pw_gid
2686
uid = pwd.getpwnam(name).pw_uid
2687
gid = pwd.getpwnam(name).pw_gid
2688
break
1780
2689
except KeyError:
1781
try:
1782
uid = pwd.getpwnam(u"nobody").pw_uid
1783
gid = pwd.getpwnam(u"nobody").pw_gid
1784
except KeyError:
1785
uid = 65534
1786
gid = 65534
2690
continue
2691
else:
2692
uid = 65534
2693
gid = 65534
1787
2694
try:
1788
2695
os.setgid(gid)
1789
2696
os.setuid(uid)
1790
except OSError, error:
1791
if error[0] != errno.EPERM:
1792
raise error
2697
except OSError as error:
2698
if error.errno != errno.EPERM:
2699
raise
1793
2700
1794
if not debug and not debuglevel:
1795
syslogger.setLevel(logging.WARNING)
1796
console.setLevel(logging.WARNING)
1797
if debuglevel:
1798
level = getattr(logging, debuglevel.upper())
1799
syslogger.setLevel(level)
1800
console.setLevel(level)
1801
1802
2701
if debug:
1803
2702
# Enable all possible GnuTLS debugging
1804
2703
1808
2707
1809
2708
@gnutls.library.types.gnutls_log_func
1810
2709
def debug_gnutls(level, string):
1811
logger.debug(u"GnuTLS: %s", string[:-1])
2710
logger.debug("GnuTLS: %s", string[:-1])
1812
2711
1813
(gnutls.library.functions
1814
.gnutls_global_set_log_function(debug_gnutls))
2712
gnutls.library.functions.gnutls_global_set_log_function(
2713
debug_gnutls)
1815
2714
1816
2715
# Redirect stdin so all checkers get /dev/null
1817
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2716
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1818
2717
os.dup2(null, sys.stdin.fileno())
1819
2718
if null > 2:
1820
2719
os.close(null)
1821
else:
1822
# No console logging
1823
logger.removeHandler(console)
1824
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()
1825
2729
1826
2730
global main_loop
1827
2731
# From the Avahi example code
1828
DBusGMainLoop(set_as_default=True )
2732
DBusGMainLoop(set_as_default=True)
1829
2733
main_loop = gobject.MainLoop()
1830
2734
bus = dbus.SystemBus()
1831
2735
# End of Avahi example code
1832
2736
if use_dbus:
1833
2737
try:
1834
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1835
bus, do_not_queue=True)
1836
except dbus.exceptions.NameExistsException, e:
1837
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)
1838
2746
use_dbus = False
1839
server_settings[u"use_dbus"] = False
2747
server_settings["use_dbus"] = False
1840
2748
tcp_server.use_dbus = False
1841
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1842
service = AvahiService(name = server_settings[u"servicename"],
1843
servicetype = u"_mandos._tcp",
1844
protocol = protocol, bus = bus)
1845
if server_settings["interface"]:
1846
service.interface = (if_nametoindex
1847
(str(server_settings[u"interface"])))
1848
1849
if not debug:
1850
# Close all input and output, do double fork, etc.
1851
daemon()
1852
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
1853
2760
global multiprocessing_manager
1854
2761
multiprocessing_manager = multiprocessing.Manager()
1855
2762
1856
2763
client_class = Client
1857
2764
if use_dbus:
1858
2765
client_class = functools.partial(ClientDBus, bus = bus)
1859
def client_config_items(config, section):
1860
special_settings = {
1861
"approved_by_default":
1862
lambda: config.getboolean(section,
1863
"approved_by_default"),
1864
}
1865
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))
1866
2850
try:
1867
yield (name, special_settings[name]())
1868
except KeyError:
1869
yield (name, value)
1870
1871
tcp_server.clients.update(set(
1872
client_class(name = section,
1873
config= dict(client_config_items(
1874
client_config, section)))
1875
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
1876
2876
if not tcp_server.clients:
1877
logger.warning(u"No clients defined")
1878
1879
if not debug:
1880
try:
1881
with pidfile:
1882
pid = os.getpid()
1883
pidfile.write(str(pid) + "\n")
1884
del pidfile
1885
except IOError:
1886
logger.error(u"Could not write to file %r with PID %d",
1887
pidfilename, pid)
1888
except NameError:
1889
# "pidfile" was never created
1890
pass
2877
logger.warning("No clients defined")
2878
2879
if not foreground:
2880
if pidfile is not None:
2881
pid = os.getpid()
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)
2888
del pidfile
1891
2889
del pidfilename
1892
1893
signal.signal(signal.SIGINT, signal.SIG_IGN)
1894
2890
1895
2891
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1896
2892
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1897
2893
1898
2894
if use_dbus:
1899
class MandosDBusService(dbus.service.Object):
2895
2896
@alternate_dbus_interfaces(
2897
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2898
class MandosDBusService(DBusObjectWithObjectManager):
1900
2899
"""A D-Bus proxy object"""
2900
1901
2901
def __init__(self):
1902
dbus.service.Object.__init__(self, bus, u"/")
1903
_interface = u"se.bsnet.fukt.Mandos"
1904
1905
@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")
1906
2907
def ClientAdded(self, objpath):
1907
2908
"D-Bus signal"
1908
2909
pass
1909
2910
1910
@dbus.service.signal(_interface, signature=u"ss")
2911
@dbus.service.signal(_interface, signature="ss")
1911
2912
def ClientNotFound(self, fingerprint, address):
1912
2913
"D-Bus signal"
1913
2914
pass
1914
2915
1915
@dbus.service.signal(_interface, signature=u"os")
2916
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2917
"true"})
2918
@dbus.service.signal(_interface, signature="os")
1916
2919
def ClientRemoved(self, objpath, name):
1917
2920
"D-Bus signal"
1918
2921
pass
1919
2922
1920
@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")
1921
2926
def GetAllClients(self):
1922
2927
"D-Bus method"
1923
return dbus.Array(c.dbus_object_path
1924
for c in tcp_server.clients)
2928
return dbus.Array(c.dbus_object_path for c in
2929
tcp_server.clients.itervalues())
1925
2930
2931
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2932
"true"})
1926
2933
@dbus.service.method(_interface,
1927
out_signature=u"a{oa{sv}}")
2934
out_signature="a{oa{sv}}")
1928
2935
def GetAllClientsWithProperties(self):
1929
2936
"D-Bus method"
1930
2937
return dbus.Dictionary(
1931
((c.dbus_object_path, c.GetAll(u""))
1932
for c in tcp_server.clients),
1933
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}")
1934
2942
1935
@dbus.service.method(_interface, in_signature=u"o")
2943
@dbus.service.method(_interface, in_signature="o")
1936
2944
def RemoveClient(self, object_path):
1937
2945
"D-Bus method"
1938
for c in tcp_server.clients:
2946
for c in tcp_server.clients.itervalues():
1939
2947
if c.dbus_object_path == object_path:
1940
tcp_server.clients.remove(c)
2948
del tcp_server.clients[c.name]
1941
2949
c.remove_from_connection()
1942
# Don't signal anything except ClientRemoved
2950
# Don't signal the disabling
1943
2951
c.disable(quiet=True)
1944
# Emit D-Bus signal
1945
self.ClientRemoved(object_path, c.name)
2952
# Emit D-Bus signal for removal
2953
self.client_removed_signal(c)
1946
2954
return
1947
2955
raise KeyError(object_path)
1948
2956
1949
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)
1950
2994
1951
2995
mandos_dbus_service = MandosDBusService()
1952
2996
1953
2997
def cleanup():
1954
2998
"Cleanup function; run on exit"
1955
service.cleanup()
1956
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
1957
3060
while tcp_server.clients:
1958
client = tcp_server.clients.pop()
3061
name, client = tcp_server.clients.popitem()
1959
3062
if use_dbus:
1960
3063
client.remove_from_connection()
1961
client.disable_hook = None
1962
# Don't signal anything except ClientRemoved
3064
# Don't signal the disabling
1963
3065
client.disable(quiet=True)
1964
if use_dbus:
1965
# Emit D-Bus signal
1966
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
1967
client.name)
3066
# Emit D-Bus signal for removal
3067
mandos_dbus_service.client_removed_signal(client)
3068
client_settings.clear()
1968
3069
1969
3070
atexit.register(cleanup)
1970
3071
1971
for client in tcp_server.clients:
3072
for client in tcp_server.clients.itervalues():
1972
3073
if use_dbus:
1973
# Emit D-Bus signal
1974
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1975
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()
1976
3079
1977
3080
tcp_server.enable()
1978
3081
tcp_server.server_activate()
1979
3082
1980
3083
# Find out what port we got
1981
service.port = tcp_server.socket.getsockname()[1]
3084
if zeroconf:
3085
service.port = tcp_server.socket.getsockname()[1]
1982
3086
if use_ipv6:
1983
logger.info(u"Now listening on address %r, port %d,"
1984
" flowinfo %d, scope_id %d"
1985
% 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())
1986
3090
else: # IPv4
1987
logger.info(u"Now listening on address %r, port %d"
1988
% tcp_server.socket.getsockname())
3091
logger.info("Now listening on address %r, port %d",
3092
*tcp_server.socket.getsockname())
1989
3093
1990
3094
#service.interface = tcp_server.socket.getsockname()[3]
1991
3095
1992
3096
try:
1993
# From the Avahi example code
1994
try:
1995
service.activate()
1996
except dbus.exceptions.DBusException, error:
1997
logger.critical(u"DBusException: %s", error)
1998
cleanup()
1999
sys.exit(1)
2000
# 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
2001
3106
2002
3107
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2003
3108
lambda *args, **kwargs:
2004
3109
(tcp_server.handle_request
2005
3110
(*args[2:], **kwargs) or True))
2006
3111
2007
logger.debug(u"Starting main loop")
3112
logger.debug("Starting main loop")
2008
3113
main_loop.run()
2009
except AvahiError, error:
2010
logger.critical(u"AvahiError: %s", error)
3114
except AvahiError as error:
3115
logger.critical("Avahi Error", exc_info=error)
2011
3116
cleanup()
2012
3117
sys.exit(1)
2013
3118
except KeyboardInterrupt:
2014
3119
if debug:
2015
print >> sys.stderr
2016
logger.debug(u"Server received KeyboardInterrupt")
2017
logger.debug(u"Server exiting")
3120
print("", file=sys.stderr)
3121
logger.debug("Server received KeyboardInterrupt")
3122
logger.debug("Server exiting")
2018
3123
# Must run before the D-Bus bus name gets deregistered
2019
3124
cleanup()
2020
3125
3126
2021
3127
if __name__ == '__main__':
2022
3128
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0