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