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