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