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