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