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.
- files added:
- bugs.xml
- debian/upstream
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
#
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
#
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
#
12
#
13
13
# Everything else is
14
# Copyright © 2008-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.3"
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
494
382
495
class AvahiServiceToSyslog(AvahiService):
383
def rename(self):
496
def rename(self, *args, **kwargs):
384
497
"""Add the new name to the syslog messages"""
385
ret = AvahiService.rename(self)
386
syslogger.setFormatter(logging.Formatter
387
('Mandos ({0}) [%(process)d]:'
388
' %(levelname)s: %(message)s'
389
.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)))
390
502
return ret
391
503
392
def timedelta_to_milliseconds(td):
393
"Convert a datetime.timedelta() to milliseconds"
394
return ((td.days * 24 * 60 * 60 * 1000)
395
+ (td.seconds * 1000)
396
+ (td.microseconds // 1000))
504
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()
777
397
778
398
779
class Client(object):
399
780
"""A representation of a client host served by this server.
400
781
401
782
Attributes:
402
783
approved: bool(); 'None' if not yet approved/disapproved
403
784
approval_delay: datetime.timedelta(); Time to wait for approval
405
786
checker: subprocess.Popen(); a running checker process used
406
787
to see if the client lives.
407
788
'None' if no process is running.
408
checker_callback_tag: a gobject event source tag, or None
789
checker_callback_tag: a GLib event source tag, or None
409
790
checker_command: string; External command which is run to check
410
791
if client lives. %() expansions are done at
411
792
runtime with vars(self) as dict, so that for
412
793
instance %(name)s can be used in the command.
413
checker_initiator_tag: a gobject event source tag, or None
794
checker_initiator_tag: a GLib event source tag, or None
414
795
created: datetime.datetime(); (UTC) object creation
415
796
client_structure: Object describing what attributes a client has
416
797
and is used for storing the client at exit
417
798
current_checker_command: string; current running checker_command
418
disable_initiator_tag: a gobject event source tag, or None
799
disable_initiator_tag: a GLib event source tag, or None
419
800
enabled: bool()
420
801
fingerprint: string (40 or 32 hexadecimal digits); used to
421
802
uniquely identify the client
426
807
last_checker_status: integer between 0 and 255 reflecting exit
427
808
status of last checker. -1 reflects crashed
428
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
429
812
last_enabled: datetime.datetime(); (UTC) or None
430
813
name: string; from the config file, used in log messages and
431
814
D-Bus identifiers
436
819
runtime_expansions: Allowed attributes for runtime expansion.
437
820
expires: datetime.datetime(); time (UTC) when a client will be
438
821
disabled, or None
822
server_settings: The server_settings dict from main()
439
823
"""
440
824
441
825
runtime_expansions = ("approval_delay", "approval_duration",
442
"created", "enabled", "fingerprint",
443
"host", "interval", "last_checked_ok",
826
"created", "enabled", "expires",
827
"fingerprint", "host", "interval",
828
"last_approval_request", "last_checked_ok",
444
829
"last_enabled", "name", "timeout")
445
client_defaults = { "timeout": "5m",
446
"extended_timeout": "15m",
447
"interval": "2m",
448
"checker": "fping -q -- %%(host)s",
449
"host": "",
450
"approval_delay": "0s",
451
"approval_duration": "1s",
452
"approved_by_default": "True",
453
"enabled": "True",
454
}
455
456
def timeout_milliseconds(self):
457
"Return the 'timeout' attribute in milliseconds"
458
return timedelta_to_milliseconds(self.timeout)
459
460
def extended_timeout_milliseconds(self):
461
"Return the 'extended_timeout' attribute in milliseconds"
462
return timedelta_to_milliseconds(self.extended_timeout)
463
464
def interval_milliseconds(self):
465
"Return the 'interval' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.interval)
467
468
def approval_delay_milliseconds(self):
469
return timedelta_to_milliseconds(self.approval_delay)
470
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
471
842
@staticmethod
472
843
def config_parser(config):
473
844
"""Construct a new dict of client settings of this form:
480
851
for client_name in config.sections():
481
852
section = dict(config.items(client_name))
482
853
client = settings[client_name] = {}
483
854
484
855
client["host"] = section["host"]
485
856
# Reformat values from string types to Python types
486
857
client["approved_by_default"] = config.getboolean(
487
858
client_name, "approved_by_default")
488
859
client["enabled"] = config.getboolean(client_name,
489
860
"enabled")
490
861
862
# Uppercase and remove spaces from fingerprint for later
863
# comparison purposes with return value from the
864
# fingerprint() function
491
865
client["fingerprint"] = (section["fingerprint"].upper()
492
866
.replace(" ", ""))
493
867
if "secret" in section:
494
client["secret"] = section["secret"].decode("base64")
868
client["secret"] = codecs.decode(section["secret"]
869
.encode("utf-8"),
870
"base64")
495
871
elif "secfile" in section:
496
872
with open(os.path.expanduser(os.path.expandvars
497
873
(section["secfile"])),
498
874
"rb") as secfile:
499
875
client["secret"] = secfile.read()
500
876
else:
501
raise TypeError("No secret or secfile for section {0}"
877
raise TypeError("No secret or secfile for section {}"
502
878
.format(section))
503
879
client["timeout"] = string_to_delta(section["timeout"])
504
880
client["extended_timeout"] = string_to_delta(
512
888
client["last_approval_request"] = None
513
889
client["last_checked_ok"] = None
514
890
client["last_checker_status"] = -2
515
891
516
892
return settings
517
518
def __init__(self, settings, name = None):
893
894
def __init__(self, settings, name=None, server_settings=None):
519
895
self.name = name
896
if server_settings is None:
897
server_settings = {}
898
self.server_settings = server_settings
520
899
# adding all client settings
521
for setting, value in settings.iteritems():
900
for setting, value in settings.items():
522
901
setattr(self, setting, value)
523
902
524
903
if self.enabled:
525
904
if not hasattr(self, "last_enabled"):
526
905
self.last_enabled = datetime.datetime.utcnow()
530
909
else:
531
910
self.last_enabled = None
532
911
self.expires = None
533
912
534
913
logger.debug("Creating client %r", self.name)
535
# Uppercase and remove spaces from fingerprint for later
536
# comparison purposes with return value from the fingerprint()
537
# function
538
914
logger.debug(" Fingerprint: %s", self.fingerprint)
539
915
self.created = settings.get("created",
540
916
datetime.datetime.utcnow())
541
917
542
918
# attributes specific for this server instance
543
919
self.checker = None
544
920
self.checker_initiator_tag = None
547
923
self.current_checker_command = None
548
924
self.approved = None
549
925
self.approvals_pending = 0
550
self.changedstate = (multiprocessing_manager
551
.Condition(multiprocessing_manager
552
.Lock()))
553
self.client_structure = [attr for attr in
554
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()
555
930
if not attr.startswith("_")]
556
931
self.client_structure.append("client_structure")
557
558
for name, t in inspect.getmembers(type(self),
559
lambda obj:
560
isinstance(obj,
561
property)):
932
933
for name, t in inspect.getmembers(
934
type(self), lambda obj: isinstance(obj, property)):
562
935
if not name.startswith("_"):
563
936
self.client_structure.append(name)
564
937
565
938
# Send notice to process children that client state has changed
566
939
def send_changedstate(self):
567
940
with self.changedstate:
568
941
self.changedstate.notify_all()
569
942
570
943
def enable(self):
571
944
"""Start this client's checker and timeout hooks"""
572
945
if getattr(self, "enabled", False):
577
950
self.last_enabled = datetime.datetime.utcnow()
578
951
self.init_checker()
579
952
self.send_changedstate()
580
953
581
954
def disable(self, quiet=True):
582
955
"""Disable this client."""
583
956
if not getattr(self, "enabled", False):
585
958
if not quiet:
586
959
logger.info("Disabling client %s", self.name)
587
960
if getattr(self, "disable_initiator_tag", None) is not None:
588
gobject.source_remove(self.disable_initiator_tag)
961
GLib.source_remove(self.disable_initiator_tag)
589
962
self.disable_initiator_tag = None
590
963
self.expires = None
591
964
if getattr(self, "checker_initiator_tag", None) is not None:
592
gobject.source_remove(self.checker_initiator_tag)
965
GLib.source_remove(self.checker_initiator_tag)
593
966
self.checker_initiator_tag = None
594
967
self.stop_checker()
595
968
self.enabled = False
596
969
if not quiet:
597
970
self.send_changedstate()
598
# 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
599
972
return False
600
973
601
974
def __del__(self):
602
975
self.disable()
603
976
604
977
def init_checker(self):
605
978
# Schedule a new checker to be started an 'interval' from now,
606
979
# and every interval from then on.
607
980
if self.checker_initiator_tag is not None:
608
gobject.source_remove(self.checker_initiator_tag)
609
self.checker_initiator_tag = (gobject.timeout_add
610
(self.interval_milliseconds(),
611
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)
612
985
# Schedule a disable() when 'timeout' has passed
613
986
if self.disable_initiator_tag is not None:
614
gobject.source_remove(self.disable_initiator_tag)
615
self.disable_initiator_tag = (gobject.timeout_add
616
(self.timeout_milliseconds(),
617
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)
618
990
# Also start a new checker *right now*.
619
991
self.start_checker()
620
621
def checker_callback(self, pid, condition, command):
992
993
def checker_callback(self, source, condition, connection,
994
command):
622
995
"""The checker has completed, so take appropriate actions."""
623
996
self.checker_callback_tag = None
624
997
self.checker = None
625
if os.WIFEXITED(condition):
626
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
627
1005
if self.last_checker_status == 0:
628
1006
logger.info("Checker for %(name)s succeeded",
629
1007
vars(self))
630
1008
self.checked_ok()
631
1009
else:
632
logger.info("Checker for %(name)s failed",
633
vars(self))
1010
logger.info("Checker for %(name)s failed", vars(self))
634
1011
else:
635
1012
self.last_checker_status = -1
1013
self.last_checker_signal = -returncode
636
1014
logger.warning("Checker for %(name)s crashed?",
637
1015
vars(self))
638
1016
return False
1017
639
1018
def checked_ok(self):
640
1019
"""Assert that the client has been seen, alive and well."""
641
1020
self.last_checked_ok = datetime.datetime.utcnow()
642
1021
self.last_checker_status = 0
1022
self.last_checker_signal = None
643
1023
self.bump_timeout()
644
1024
645
1025
def bump_timeout(self, timeout=None):
646
1026
"""Bump up the timeout for this client."""
647
1027
if timeout is None:
648
1028
timeout = self.timeout
649
1029
if self.disable_initiator_tag is not None:
650
gobject.source_remove(self.disable_initiator_tag)
1030
GLib.source_remove(self.disable_initiator_tag)
651
1031
self.disable_initiator_tag = None
652
1032
if getattr(self, "enabled", False):
653
self.disable_initiator_tag = (gobject.timeout_add
654
(timedelta_to_milliseconds
655
(timeout), self.disable))
1033
self.disable_initiator_tag = GLib.timeout_add(
1034
int(timeout.total_seconds() * 1000), self.disable)
656
1035
self.expires = datetime.datetime.utcnow() + timeout
657
1036
658
1037
def need_approval(self):
659
1038
self.last_approval_request = datetime.datetime.utcnow()
660
1039
661
1040
def start_checker(self):
662
1041
"""Start a new checker subprocess if one is not running.
663
1042
664
1043
If a checker already exists, leave it running and do
665
1044
nothing."""
666
1045
# The reason for not killing a running checker is that if we
671
1050
# checkers alone, the checker would have to take more time
672
1051
# than 'timeout' for the client to be disabled, which is as it
673
1052
# should be.
674
675
# If a checker exists, make sure it is not a zombie
676
try:
677
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
except (AttributeError, OSError) as error:
679
if (isinstance(error, OSError)
680
and error.errno != errno.ECHILD):
681
raise error
682
else:
683
if pid:
684
logger.warning("Checker was a zombie")
685
gobject.source_remove(self.checker_callback_tag)
686
self.checker_callback(pid, status,
687
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
688
1058
# Start a new checker if needed
689
1059
if self.checker is None:
1060
# Escape attributes for the shell
1061
escaped_attrs = {
1062
attr: re.escape(str(getattr(self, attr)))
1063
for attr in self.runtime_expansions}
690
1064
try:
691
# In case checker_command has exactly one % operator
692
command = self.checker_command % self.host
693
except TypeError:
694
# Escape attributes for the shell
695
escaped_attrs = dict(
696
(attr,
697
re.escape(unicode(str(getattr(self, attr, "")),
698
errors=
699
'replace')))
700
for attr in
701
self.runtime_expansions)
702
703
try:
704
command = self.checker_command % escaped_attrs
705
except TypeError as error:
706
logger.error('Could not format string "%s"',
707
self.checker_command, exc_info=error)
708
return True # Try again later
1065
command = self.checker_command % escaped_attrs
1066
except TypeError as error:
1067
logger.error('Could not format string "%s"',
1068
self.checker_command,
1069
exc_info=error)
1070
return True # Try again later
709
1071
self.current_checker_command = command
710
try:
711
logger.info("Starting checker %r for %s",
712
command, self.name)
713
# We don't need to redirect stdout and stderr, since
714
# in normal mode, that is already done by daemon(),
715
# and in debug mode we don't want to. (Stdin is
716
# always replaced by /dev/null.)
717
self.checker = subprocess.Popen(command,
718
close_fds=True,
719
shell=True, cwd="/")
720
self.checker_callback_tag = (gobject.child_watch_add
721
(self.checker.pid,
722
self.checker_callback,
723
data=command))
724
# The checker may have completed before the gobject
725
# watch was added. Check for this.
726
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
727
if pid:
728
gobject.source_remove(self.checker_callback_tag)
729
self.checker_callback(pid, status, command)
730
except OSError as error:
731
logger.error("Failed to start subprocess",
732
exc_info=error)
733
# 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
734
1098
return True
735
1099
736
1100
def stop_checker(self):
737
1101
"""Force the checker process, if any, to stop."""
738
1102
if self.checker_callback_tag:
739
gobject.source_remove(self.checker_callback_tag)
1103
GLib.source_remove(self.checker_callback_tag)
740
1104
self.checker_callback_tag = None
741
1105
if getattr(self, "checker", None) is None:
742
1106
return
743
1107
logger.debug("Stopping checker for %(name)s", vars(self))
744
try:
745
self.checker.terminate()
746
#time.sleep(0.5)
747
#if self.checker.poll() is None:
748
# self.checker.kill()
749
except OSError as error:
750
if error.errno != errno.ESRCH: # No such process
751
raise
1108
self.checker.terminate()
752
1109
self.checker = None
753
1110
754
1111
755
def dbus_service_property(dbus_interface, signature="v",
756
access="readwrite", byte_arrays=False):
1112
def dbus_service_property(dbus_interface,
1113
signature="v",
1114
access="readwrite",
1115
byte_arrays=False):
757
1116
"""Decorators for marking methods of a DBusObjectWithProperties to
758
1117
become properties on the D-Bus.
759
1118
760
1119
The decorated method will be called with no arguments by "Get"
761
1120
and with one argument by "Set".
762
1121
763
1122
The parameters, where they are supported, are the same as
764
1123
dbus.service.method, except there is only "signature", since the
765
1124
type from Get() and the type sent to Set() is the same.
768
1127
# "Set" method, so we fail early here:
769
1128
if byte_arrays and signature != "ay":
770
1129
raise ValueError("Byte arrays not supported for non-'ay'"
771
" signature {0!r}".format(signature))
1130
" signature {!r}".format(signature))
1131
772
1132
def decorator(func):
773
1133
func._dbus_is_property = True
774
1134
func._dbus_interface = dbus_interface
777
1137
func._dbus_name = func.__name__
778
1138
if func._dbus_name.endswith("_dbus_property"):
779
1139
func._dbus_name = func._dbus_name[:-14]
780
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1140
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
781
1141
return func
1142
782
1143
return decorator
783
1144
784
1145
785
1146
def dbus_interface_annotations(dbus_interface):
786
1147
"""Decorator for marking functions returning interface annotations
787
1148
788
1149
Usage:
789
1150
790
1151
@dbus_interface_annotations("org.example.Interface")
791
1152
def _foo(self): # Function name does not matter
792
1153
return {"org.freedesktop.DBus.Deprecated": "true",
793
1154
"org.freedesktop.DBus.Property.EmitsChangedSignal":
794
1155
"false"}
795
1156
"""
1157
796
1158
def decorator(func):
797
1159
func._dbus_is_interface = True
798
1160
func._dbus_interface = dbus_interface
799
1161
func._dbus_name = dbus_interface
800
1162
return func
1163
801
1164
return decorator
802
1165
803
1166
804
1167
def dbus_annotations(annotations):
805
1168
"""Decorator to annotate D-Bus methods, signals or properties
806
1169
Usage:
807
1170
1171
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1172
"org.freedesktop.DBus.Property."
1173
"EmitsChangedSignal": "false"})
808
1174
@dbus_service_property("org.example.Interface", signature="b",
809
1175
access="r")
810
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
811
"org.freedesktop.DBus.Property."
812
"EmitsChangedSignal": "false"})
813
1176
def Property_dbus_property(self):
814
1177
return dbus.Boolean(False)
1178
1179
See also the DBusObjectWithAnnotations class.
815
1180
"""
1181
816
1182
def decorator(func):
817
1183
func._dbus_annotations = annotations
818
1184
return func
1185
819
1186
return decorator
820
1187
821
1188
822
1189
class DBusPropertyException(dbus.exceptions.DBusException):
823
1190
"""A base class for D-Bus property-related exceptions
824
1191
"""
825
def __unicode__(self):
826
return unicode(str(self))
1192
pass
827
1193
828
1194
829
1195
class DBusPropertyAccessException(DBusPropertyException):
838
1204
pass
839
1205
840
1206
841
class DBusObjectWithProperties(dbus.service.Object):
842
"""A D-Bus object with properties.
843
844
Classes inheriting from this can use the dbus_service_property
845
decorator to expose methods as D-Bus properties. It exposes the
846
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.
847
1212
"""
848
1213
849
1214
@staticmethod
850
1215
def _is_dbus_thing(thing):
851
1216
"""Returns a function testing if an attribute is a D-Bus thing
852
1217
853
1218
If called like _is_dbus_thing("method") it returns a function
854
1219
suitable for use as predicate to inspect.getmembers().
855
1220
"""
856
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1221
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
857
1222
False)
858
1223
859
1224
def _get_all_dbus_things(self, thing):
860
1225
"""Returns a generator of (name, attribute) pairs
861
1226
"""
862
return ((getattr(athing.__get__(self), "_dbus_name",
863
name),
1227
return ((getattr(athing.__get__(self), "_dbus_name", name),
864
1228
athing.__get__(self))
865
1229
for cls in self.__class__.__mro__
866
1230
for name, athing in
867
inspect.getmembers(cls,
868
self._is_dbus_thing(thing)))
869
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
870
1304
def _get_dbus_property(self, interface_name, property_name):
871
1305
"""Returns a bound method if one exists which is a D-Bus
872
1306
property with the specified name and interface.
873
1307
"""
874
for cls in self.__class__.__mro__:
875
for name, value in (inspect.getmembers
876
(cls,
877
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")):
878
1311
if (value._dbus_name == property_name
879
1312
and value._dbus_interface == interface_name):
880
1313
return value.__get__(self)
881
1314
882
1315
# No such property
883
raise DBusPropertyNotFound(self.dbus_object_path + ":"
884
+ interface_name + "."
885
+ property_name)
886
887
@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",
888
1330
out_signature="v")
889
1331
def Get(self, interface_name, property_name):
890
1332
"""Standard D-Bus property Get() method, see D-Bus standard.
896
1338
if not hasattr(value, "variant_level"):
897
1339
return value
898
1340
return type(value)(value, variant_level=value.variant_level+1)
899
1341
900
1342
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
901
1343
def Set(self, interface_name, property_name, value):
902
1344
"""Standard D-Bus property Set() method, see D-Bus standard.
908
1350
# The byte_arrays option is not supported yet on
909
1351
# signatures other than "ay".
910
1352
if prop._dbus_signature != "ay":
911
raise ValueError
1353
raise ValueError("Byte arrays not supported for non-"
1354
"'ay' signature {!r}"
1355
.format(prop._dbus_signature))
912
1356
value = dbus.ByteArray(b''.join(chr(byte)
913
1357
for byte in value))
914
1358
prop(value)
915
916
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1359
1360
@dbus.service.method(dbus.PROPERTIES_IFACE,
1361
in_signature="s",
917
1362
out_signature="a{sv}")
918
1363
def GetAll(self, interface_name):
919
1364
"""Standard D-Bus property GetAll() method, see D-Bus
920
1365
standard.
921
1366
922
1367
Note: Will not include properties with access="write".
923
1368
"""
924
1369
properties = {}
934
1379
if not hasattr(value, "variant_level"):
935
1380
properties[name] = value
936
1381
continue
937
properties[name] = type(value)(value, variant_level=
938
value.variant_level+1)
1382
properties[name] = type(value)(
1383
value, variant_level=value.variant_level + 1)
939
1384
return dbus.Dictionary(properties, signature="sv")
940
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
941
1394
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
942
1395
out_signature="s",
943
1396
path_keyword='object_path',
944
1397
connection_keyword='connection')
945
1398
def Introspect(self, object_path, connection):
946
1399
"""Overloading of standard D-Bus method.
947
1400
948
1401
Inserts property tags and interface annotation tags.
949
1402
"""
950
xmlstring = dbus.service.Object.Introspect(self, object_path,
951
connection)
1403
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1404
object_path,
1405
connection)
952
1406
try:
953
1407
document = xml.dom.minidom.parseString(xmlstring)
1408
954
1409
def make_tag(document, name, prop):
955
1410
e = document.createElement("property")
956
1411
e.setAttribute("name", name)
957
1412
e.setAttribute("type", prop._dbus_signature)
958
1413
e.setAttribute("access", prop._dbus_access)
959
1414
return e
1415
960
1416
for if_tag in document.getElementsByTagName("interface"):
961
1417
# Add property tags
962
1418
for tag in (make_tag(document, name, prop)
965
1421
if prop._dbus_interface
966
1422
== if_tag.getAttribute("name")):
967
1423
if_tag.appendChild(tag)
968
# Add annotation tags
969
for typ in ("method", "signal", "property"):
970
for tag in if_tag.getElementsByTagName(typ):
971
annots = dict()
972
for name, prop in (self.
973
_get_all_dbus_things(typ)):
974
if (name == tag.getAttribute("name")
975
and prop._dbus_interface
976
== if_tag.getAttribute("name")):
977
annots.update(getattr
978
(prop,
979
"_dbus_annotations",
980
{}))
981
for name, value in annots.iteritems():
982
ann_tag = document.createElement(
983
"annotation")
984
ann_tag.setAttribute("name", name)
985
ann_tag.setAttribute("value", value)
986
tag.appendChild(ann_tag)
987
# Add interface annotation tags
988
for annotation, value in dict(
989
itertools.chain.from_iterable(
990
annotations().iteritems()
991
for name, annotations in
992
self._get_all_dbus_things("interface")
993
if name == if_tag.getAttribute("name")
994
)).iteritems():
995
ann_tag = document.createElement("annotation")
996
ann_tag.setAttribute("name", annotation)
997
ann_tag.setAttribute("value", value)
998
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)
999
1440
# Add the names to the return values for the
1000
1441
# "org.freedesktop.DBus.Properties" methods
1001
1442
if (if_tag.getAttribute("name")
1020
1461
return xmlstring
1021
1462
1022
1463
1023
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):
1024
1536
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1025
1537
if dt is None:
1026
return dbus.String("", variant_level = variant_level)
1027
return dbus.String(dt.isoformat(),
1028
variant_level=variant_level)
1538
return dbus.String("", variant_level=variant_level)
1539
return dbus.String(dt.isoformat(), variant_level=variant_level)
1029
1540
1030
1541
1031
1542
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1033
1544
dbus.service.Object, it will add alternate D-Bus attributes with
1034
1545
interface names according to the "alt_interface_names" mapping.
1035
1546
Usage:
1036
1037
@alternate_dbus_names({"org.example.Interface":
1038
"net.example.AlternateInterface"})
1547
1548
@alternate_dbus_interfaces({"org.example.Interface":
1549
"net.example.AlternateInterface"})
1039
1550
class SampleDBusObject(dbus.service.Object):
1040
1551
@dbus.service.method("org.example.Interface")
1041
1552
def SampleDBusMethod():
1042
1553
pass
1043
1554
1044
1555
The above "SampleDBusMethod" on "SampleDBusObject" will be
1045
1556
reachable via two interfaces: "org.example.Interface" and
1046
1557
"net.example.AlternateInterface", the latter of which will have
1047
1558
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1048
1559
"true", unless "deprecate" is passed with a False value.
1049
1560
1050
1561
This works for methods and signals, and also for D-Bus properties
1051
1562
(from DBusObjectWithProperties) and interfaces (from the
1052
1563
dbus_interface_annotations decorator).
1053
1564
"""
1565
1054
1566
def wrapper(cls):
1055
1567
for orig_interface_name, alt_interface_name in (
1056
alt_interface_names.iteritems()):
1568
alt_interface_names.items()):
1057
1569
attr = {}
1058
1570
interface_names = set()
1059
1571
# Go though all attributes of the class
1061
1573
# Ignore non-D-Bus attributes, and D-Bus attributes
1062
1574
# with the wrong interface name
1063
1575
if (not hasattr(attribute, "_dbus_interface")
1064
or not attribute._dbus_interface
1065
.startswith(orig_interface_name)):
1576
or not attribute._dbus_interface.startswith(
1577
orig_interface_name)):
1066
1578
continue
1067
1579
# Create an alternate D-Bus interface name based on
1068
1580
# the current name
1069
alt_interface = (attribute._dbus_interface
1070
.replace(orig_interface_name,
1071
alt_interface_name))
1581
alt_interface = attribute._dbus_interface.replace(
1582
orig_interface_name, alt_interface_name)
1072
1583
interface_names.add(alt_interface)
1073
1584
# Is this a D-Bus signal?
1074
1585
if getattr(attribute, "_dbus_is_signal", False):
1075
# Extract the original non-method function by
1076
# black magic
1077
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(
1078
1590
zip(attribute.func_code.co_freevars,
1079
attribute.__closure__))["func"]
1080
.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)
1081
1598
# Create a new, but exactly alike, function
1082
1599
# object, and decorate it to be a new D-Bus signal
1083
1600
# with the alternate D-Bus interface name
1084
new_function = (dbus.service.signal
1085
(alt_interface,
1086
attribute._dbus_signature)
1087
(types.FunctionType(
1088
nonmethod_func.func_code,
1089
nonmethod_func.func_globals,
1090
nonmethod_func.func_name,
1091
nonmethod_func.func_defaults,
1092
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))
1093
1605
# Copy annotations, if any
1094
1606
try:
1095
new_function._dbus_annotations = (
1096
dict(attribute._dbus_annotations))
1607
new_function._dbus_annotations = dict(
1608
attribute._dbus_annotations)
1097
1609
except AttributeError:
1098
1610
pass
1611
1099
1612
# Define a creator of a function to call both the
1100
1613
# original and alternate functions, so both the
1101
1614
# original and alternate signals gets sent when
1104
1617
"""This function is a scope container to pass
1105
1618
func1 and func2 to the "call_both" function
1106
1619
outside of its arguments"""
1620
1621
@functools.wraps(func2)
1107
1622
def call_both(*args, **kwargs):
1108
1623
"""This function will emit two D-Bus
1109
1624
signals by calling func1 and func2"""
1110
1625
func1(*args, **kwargs)
1111
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
1112
1633
return call_both
1113
1634
# Create the "call_both" function and add it to
1114
1635
# the class
1119
1640
# object. Decorate it to be a new D-Bus method
1120
1641
# with the alternate D-Bus interface name. Add it
1121
1642
# to the class.
1122
attr[attrname] = (dbus.service.method
1123
(alt_interface,
1124
attribute._dbus_in_signature,
1125
attribute._dbus_out_signature)
1126
(types.FunctionType
1127
(attribute.func_code,
1128
attribute.func_globals,
1129
attribute.func_name,
1130
attribute.func_defaults,
1131
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)))
1132
1649
# Copy annotations, if any
1133
1650
try:
1134
attr[attrname]._dbus_annotations = (
1135
dict(attribute._dbus_annotations))
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1136
1653
except AttributeError:
1137
1654
pass
1138
1655
# Is this a D-Bus property?
1141
1658
# object, and decorate it to be a new D-Bus
1142
1659
# property with the alternate D-Bus interface
1143
1660
# name. Add it to the class.
1144
attr[attrname] = (dbus_service_property
1145
(alt_interface,
1146
attribute._dbus_signature,
1147
attribute._dbus_access,
1148
attribute
1149
._dbus_get_args_options
1150
["byte_arrays"])
1151
(types.FunctionType
1152
(attribute.func_code,
1153
attribute.func_globals,
1154
attribute.func_name,
1155
attribute.func_defaults,
1156
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)))
1157
1667
# Copy annotations, if any
1158
1668
try:
1159
attr[attrname]._dbus_annotations = (
1160
dict(attribute._dbus_annotations))
1669
attr[attrname]._dbus_annotations = dict(
1670
attribute._dbus_annotations)
1161
1671
except AttributeError:
1162
1672
pass
1163
1673
# Is this a D-Bus interface?
1166
1676
# object. Decorate it to be a new D-Bus interface
1167
1677
# with the alternate D-Bus interface name. Add it
1168
1678
# to the class.
1169
attr[attrname] = (dbus_interface_annotations
1170
(alt_interface)
1171
(types.FunctionType
1172
(attribute.func_code,
1173
attribute.func_globals,
1174
attribute.func_name,
1175
attribute.func_defaults,
1176
attribute.func_closure)))
1679
attr[attrname] = (
1680
dbus_interface_annotations(alt_interface)
1681
(copy_function(attribute)))
1177
1682
if deprecate:
1178
1683
# Deprecate all alternate interfaces
1179
iname="_AlternateDBusNames_interface_annotation{0}"
1684
iname = "_AlternateDBusNames_interface_annotation{}"
1180
1685
for interface_name in interface_names:
1686
1181
1687
@dbus_interface_annotations(interface_name)
1182
1688
def func(self):
1183
return { "org.freedesktop.DBus.Deprecated":
1184
"true" }
1689
return {"org.freedesktop.DBus.Deprecated":
1690
"true"}
1185
1691
# Find an unused name
1186
1692
for aname in (iname.format(i)
1187
1693
for i in itertools.count()):
1191
1697
if interface_names:
1192
1698
# Replace the class with a new subclass of it with
1193
1699
# methods, signals, etc. as created above.
1194
cls = type(b"{0}Alternate".format(cls.__name__),
1195
(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)
1196
1706
return cls
1707
1197
1708
return wrapper
1198
1709
1199
1710
1200
1711
@alternate_dbus_interfaces({"se.recompile.Mandos":
1201
"se.bsnet.fukt.Mandos"})
1712
"se.bsnet.fukt.Mandos"})
1202
1713
class ClientDBus(Client, DBusObjectWithProperties):
1203
1714
"""A Client class using D-Bus
1204
1715
1205
1716
Attributes:
1206
1717
dbus_object_path: dbus.ObjectPath
1207
1718
bus: dbus.SystemBus()
1208
1719
"""
1209
1720
1210
1721
runtime_expansions = (Client.runtime_expansions
1211
+ ("dbus_object_path",))
1212
1722
+ ("dbus_object_path", ))
1723
1724
_interface = "se.recompile.Mandos.Client"
1725
1213
1726
# dbus.service.Object doesn't use super(), so we can't either.
1214
1215
def __init__(self, bus = None, *args, **kwargs):
1727
1728
def __init__(self, bus=None, *args, **kwargs):
1216
1729
self.bus = bus
1217
1730
Client.__init__(self, *args, **kwargs)
1218
1731
# Only now, when this client is initialized, can it show up on
1219
1732
# the D-Bus
1220
client_object_name = unicode(self.name).translate(
1733
client_object_name = str(self.name).translate(
1221
1734
{ord("."): ord("_"),
1222
1735
ord("-"): ord("_")})
1223
self.dbus_object_path = (dbus.ObjectPath
1224
("/clients/" + client_object_name))
1736
self.dbus_object_path = dbus.ObjectPath(
1737
"/clients/" + client_object_name)
1225
1738
DBusObjectWithProperties.__init__(self, self.bus,
1226
1739
self.dbus_object_path)
1227
1228
def notifychangeproperty(transform_func,
1229
dbus_name, type_func=lambda x: x,
1230
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):
1231
1746
""" Modify a variable so that it's a property which announces
1232
1747
its changes to DBus.
1233
1748
1234
1749
transform_fun: Function that takes a value and a variant_level
1235
1750
and transforms it to a D-Bus type.
1236
1751
dbus_name: D-Bus name of the variable
1238
1753
to the D-Bus. Default: no transform
1239
1754
variant_level: D-Bus variant level. Default: 1
1240
1755
"""
1241
attrname = "_{0}".format(dbus_name)
1756
attrname = "_{}".format(dbus_name)
1757
1242
1758
def setter(self, value):
1243
1759
if hasattr(self, "dbus_object_path"):
1244
1760
if (not hasattr(self, attrname) or
1245
1761
type_func(getattr(self, attrname, None))
1246
1762
!= type_func(value)):
1247
dbus_value = transform_func(type_func(value),
1248
variant_level
1249
=variant_level)
1250
self.PropertyChanged(dbus.String(dbus_name),
1251
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())
1252
1778
setattr(self, attrname, value)
1253
1779
1254
1780
return property(lambda self: getattr(self, attrname), setter)
1255
1781
1256
1782
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1257
1783
approvals_pending = notifychangeproperty(dbus.Boolean,
1258
1784
"ApprovalPending",
1259
type_func = bool)
1785
type_func=bool)
1260
1786
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1261
1787
last_enabled = notifychangeproperty(datetime_to_dbus,
1262
1788
"LastEnabled")
1263
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1264
type_func = lambda checker:
1265
checker is not None)
1789
checker = notifychangeproperty(
1790
dbus.Boolean, "CheckerRunning",
1791
type_func=lambda checker: checker is not None)
1266
1792
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1267
1793
"LastCheckedOK")
1268
1794
last_checker_status = notifychangeproperty(dbus.Int16,
1271
1797
datetime_to_dbus, "LastApprovalRequest")
1272
1798
approved_by_default = notifychangeproperty(dbus.Boolean,
1273
1799
"ApprovedByDefault")
1274
approval_delay = notifychangeproperty(dbus.UInt64,
1275
"ApprovalDelay",
1276
type_func =
1277
timedelta_to_milliseconds)
1800
approval_delay = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDelay",
1802
type_func=lambda td: td.total_seconds() * 1000)
1278
1803
approval_duration = notifychangeproperty(
1279
1804
dbus.UInt64, "ApprovalDuration",
1280
type_func = timedelta_to_milliseconds)
1805
type_func=lambda td: td.total_seconds() * 1000)
1281
1806
host = notifychangeproperty(dbus.String, "Host")
1282
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1283
type_func =
1284
timedelta_to_milliseconds)
1807
timeout = notifychangeproperty(
1808
dbus.UInt64, "Timeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1285
1810
extended_timeout = notifychangeproperty(
1286
1811
dbus.UInt64, "ExtendedTimeout",
1287
type_func = timedelta_to_milliseconds)
1288
interval = notifychangeproperty(dbus.UInt64,
1289
"Interval",
1290
type_func =
1291
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)
1292
1816
checker_command = notifychangeproperty(dbus.String, "Checker")
1293
1817
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1818
invalidate_only=True)
1819
1294
1820
del notifychangeproperty
1295
1821
1296
1822
def __del__(self, *args, **kwargs):
1297
1823
try:
1298
1824
self.remove_from_connection()
1301
1827
if hasattr(DBusObjectWithProperties, "__del__"):
1302
1828
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1303
1829
Client.__del__(self, *args, **kwargs)
1304
1305
def checker_callback(self, pid, condition, command,
1306
*args, **kwargs):
1307
self.checker_callback_tag = None
1308
self.checker = None
1309
if os.WIFEXITED(condition):
1310
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:
1311
1838
# Emit D-Bus signal
1312
1839
self.CheckerCompleted(dbus.Int16(exitstatus),
1313
dbus.Int64(condition),
1840
# This is specific to GNU libC
1841
dbus.Int64(exitstatus << 8),
1314
1842
dbus.String(command))
1315
1843
else:
1316
1844
# Emit D-Bus signal
1317
1845
self.CheckerCompleted(dbus.Int16(-1),
1318
dbus.Int64(condition),
1846
dbus.Int64(
1847
# This is specific to GNU libC
1848
(exitstatus << 8)
1849
| self.last_checker_signal),
1319
1850
dbus.String(command))
1320
1321
return Client.checker_callback(self, pid, condition, command,
1322
*args, **kwargs)
1323
1851
return ret
1852
1324
1853
def start_checker(self, *args, **kwargs):
1325
old_checker = self.checker
1326
if self.checker is not None:
1327
old_checker_pid = self.checker.pid
1328
else:
1329
old_checker_pid = None
1854
old_checker_pid = getattr(self.checker, "pid", None)
1330
1855
r = Client.start_checker(self, *args, **kwargs)
1331
1856
# Only if new checker process was started
1332
1857
if (self.checker is not None
1334
1859
# Emit D-Bus signal
1335
1860
self.CheckerStarted(self.current_checker_command)
1336
1861
return r
1337
1862
1338
1863
def _reset_approved(self):
1339
1864
self.approved = None
1340
1865
return False
1341
1866
1342
1867
def approve(self, value=True):
1343
1868
self.approved = value
1344
gobject.timeout_add(timedelta_to_milliseconds
1345
(self.approval_duration),
1346
self._reset_approved)
1869
GLib.timeout_add(int(self.approval_duration.total_seconds()
1870
* 1000), self._reset_approved)
1347
1871
self.send_changedstate()
1348
1349
## D-Bus methods, signals & properties
1350
_interface = "se.recompile.Mandos.Client"
1351
1352
## Interfaces
1353
1354
@dbus_interface_annotations(_interface)
1355
def _foo(self):
1356
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1357
"false"}
1358
1359
## Signals
1360
1872
1873
# D-Bus methods, signals & properties
1874
1875
# Interfaces
1876
1877
# Signals
1878
1361
1879
# CheckerCompleted - signal
1362
1880
@dbus.service.signal(_interface, signature="nxs")
1363
1881
def CheckerCompleted(self, exitcode, waitstatus, command):
1364
1882
"D-Bus signal"
1365
1883
pass
1366
1884
1367
1885
# CheckerStarted - signal
1368
1886
@dbus.service.signal(_interface, signature="s")
1369
1887
def CheckerStarted(self, command):
1370
1888
"D-Bus signal"
1371
1889
pass
1372
1890
1373
1891
# PropertyChanged - signal
1892
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1374
1893
@dbus.service.signal(_interface, signature="sv")
1375
1894
def PropertyChanged(self, property, value):
1376
1895
"D-Bus signal"
1377
1896
pass
1378
1897
1379
1898
# GotSecret - signal
1380
1899
@dbus.service.signal(_interface)
1381
1900
def GotSecret(self):
1384
1903
server to mandos-client
1385
1904
"""
1386
1905
pass
1387
1906
1388
1907
# Rejected - signal
1389
1908
@dbus.service.signal(_interface, signature="s")
1390
1909
def Rejected(self, reason):
1391
1910
"D-Bus signal"
1392
1911
pass
1393
1912
1394
1913
# NeedApproval - signal
1395
1914
@dbus.service.signal(_interface, signature="tb")
1396
1915
def NeedApproval(self, timeout, default):
1397
1916
"D-Bus signal"
1398
1917
return self.need_approval()
1399
1400
## Methods
1401
1918
1919
# Methods
1920
1402
1921
# Approve - method
1403
1922
@dbus.service.method(_interface, in_signature="b")
1404
1923
def Approve(self, value):
1405
1924
self.approve(value)
1406
1925
1407
1926
# CheckedOK - method
1408
1927
@dbus.service.method(_interface)
1409
1928
def CheckedOK(self):
1410
1929
self.checked_ok()
1411
1930
1412
1931
# Enable - method
1932
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1413
1933
@dbus.service.method(_interface)
1414
1934
def Enable(self):
1415
1935
"D-Bus method"
1416
1936
self.enable()
1417
1937
1418
1938
# StartChecker - method
1939
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1419
1940
@dbus.service.method(_interface)
1420
1941
def StartChecker(self):
1421
1942
"D-Bus method"
1422
1943
self.start_checker()
1423
1944
1424
1945
# Disable - method
1946
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1425
1947
@dbus.service.method(_interface)
1426
1948
def Disable(self):
1427
1949
"D-Bus method"
1428
1950
self.disable()
1429
1951
1430
1952
# StopChecker - method
1953
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1431
1954
@dbus.service.method(_interface)
1432
1955
def StopChecker(self):
1433
1956
self.stop_checker()
1434
1435
## Properties
1436
1957
1958
# Properties
1959
1437
1960
# ApprovalPending - property
1438
1961
@dbus_service_property(_interface, signature="b", access="read")
1439
1962
def ApprovalPending_dbus_property(self):
1440
1963
return dbus.Boolean(bool(self.approvals_pending))
1441
1964
1442
1965
# ApprovedByDefault - property
1443
@dbus_service_property(_interface, signature="b",
1966
@dbus_service_property(_interface,
1967
signature="b",
1444
1968
access="readwrite")
1445
1969
def ApprovedByDefault_dbus_property(self, value=None):
1446
1970
if value is None: # get
1447
1971
return dbus.Boolean(self.approved_by_default)
1448
1972
self.approved_by_default = bool(value)
1449
1973
1450
1974
# ApprovalDelay - property
1451
@dbus_service_property(_interface, signature="t",
1975
@dbus_service_property(_interface,
1976
signature="t",
1452
1977
access="readwrite")
1453
1978
def ApprovalDelay_dbus_property(self, value=None):
1454
1979
if value is None: # get
1455
return dbus.UInt64(self.approval_delay_milliseconds())
1980
return dbus.UInt64(self.approval_delay.total_seconds()
1981
* 1000)
1456
1982
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1457
1983
1458
1984
# ApprovalDuration - property
1459
@dbus_service_property(_interface, signature="t",
1985
@dbus_service_property(_interface,
1986
signature="t",
1460
1987
access="readwrite")
1461
1988
def ApprovalDuration_dbus_property(self, value=None):
1462
1989
if value is None: # get
1463
return dbus.UInt64(timedelta_to_milliseconds(
1464
self.approval_duration))
1990
return dbus.UInt64(self.approval_duration.total_seconds()
1991
* 1000)
1465
1992
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1466
1993
1467
1994
# Name - property
1995
@dbus_annotations(
1996
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1468
1997
@dbus_service_property(_interface, signature="s", access="read")
1469
1998
def Name_dbus_property(self):
1470
1999
return dbus.String(self.name)
1471
2000
1472
2001
# Fingerprint - property
2002
@dbus_annotations(
2003
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1473
2004
@dbus_service_property(_interface, signature="s", access="read")
1474
2005
def Fingerprint_dbus_property(self):
1475
2006
return dbus.String(self.fingerprint)
1476
2007
1477
2008
# Host - property
1478
@dbus_service_property(_interface, signature="s",
2009
@dbus_service_property(_interface,
2010
signature="s",
1479
2011
access="readwrite")
1480
2012
def Host_dbus_property(self, value=None):
1481
2013
if value is None: # get
1482
2014
return dbus.String(self.host)
1483
self.host = unicode(value)
1484
2015
self.host = str(value)
2016
1485
2017
# Created - property
2018
@dbus_annotations(
2019
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1486
2020
@dbus_service_property(_interface, signature="s", access="read")
1487
2021
def Created_dbus_property(self):
1488
2022
return datetime_to_dbus(self.created)
1489
2023
1490
2024
# LastEnabled - property
1491
2025
@dbus_service_property(_interface, signature="s", access="read")
1492
2026
def LastEnabled_dbus_property(self):
1493
2027
return datetime_to_dbus(self.last_enabled)
1494
2028
1495
2029
# Enabled - property
1496
@dbus_service_property(_interface, signature="b",
2030
@dbus_service_property(_interface,
2031
signature="b",
1497
2032
access="readwrite")
1498
2033
def Enabled_dbus_property(self, value=None):
1499
2034
if value is None: # get
1502
2037
self.enable()
1503
2038
else:
1504
2039
self.disable()
1505
2040
1506
2041
# LastCheckedOK - property
1507
@dbus_service_property(_interface, signature="s",
2042
@dbus_service_property(_interface,
2043
signature="s",
1508
2044
access="readwrite")
1509
2045
def LastCheckedOK_dbus_property(self, value=None):
1510
2046
if value is not None:
1511
2047
self.checked_ok()
1512
2048
return
1513
2049
return datetime_to_dbus(self.last_checked_ok)
1514
2050
1515
2051
# LastCheckerStatus - property
1516
@dbus_service_property(_interface, signature="n",
1517
access="read")
2052
@dbus_service_property(_interface, signature="n", access="read")
1518
2053
def LastCheckerStatus_dbus_property(self):
1519
2054
return dbus.Int16(self.last_checker_status)
1520
2055
1521
2056
# Expires - property
1522
2057
@dbus_service_property(_interface, signature="s", access="read")
1523
2058
def Expires_dbus_property(self):
1524
2059
return datetime_to_dbus(self.expires)
1525
2060
1526
2061
# LastApprovalRequest - property
1527
2062
@dbus_service_property(_interface, signature="s", access="read")
1528
2063
def LastApprovalRequest_dbus_property(self):
1529
2064
return datetime_to_dbus(self.last_approval_request)
1530
2065
1531
2066
# Timeout - property
1532
@dbus_service_property(_interface, signature="t",
2067
@dbus_service_property(_interface,
2068
signature="t",
1533
2069
access="readwrite")
1534
2070
def Timeout_dbus_property(self, value=None):
1535
2071
if value is None: # get
1536
return dbus.UInt64(self.timeout_milliseconds())
2072
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1537
2073
old_timeout = self.timeout
1538
2074
self.timeout = datetime.timedelta(0, 0, 0, value)
1539
2075
# Reschedule disabling
1547
2083
if (getattr(self, "disable_initiator_tag", None)
1548
2084
is None):
1549
2085
return
1550
gobject.source_remove(self.disable_initiator_tag)
1551
self.disable_initiator_tag = (
1552
gobject.timeout_add(
1553
timedelta_to_milliseconds(self.expires - now),
1554
self.disable))
1555
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
1556
2091
# ExtendedTimeout - property
1557
@dbus_service_property(_interface, signature="t",
2092
@dbus_service_property(_interface,
2093
signature="t",
1558
2094
access="readwrite")
1559
2095
def ExtendedTimeout_dbus_property(self, value=None):
1560
2096
if value is None: # get
1561
return dbus.UInt64(self.extended_timeout_milliseconds())
2097
return dbus.UInt64(self.extended_timeout.total_seconds()
2098
* 1000)
1562
2099
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1563
2100
1564
2101
# Interval - property
1565
@dbus_service_property(_interface, signature="t",
2102
@dbus_service_property(_interface,
2103
signature="t",
1566
2104
access="readwrite")
1567
2105
def Interval_dbus_property(self, value=None):
1568
2106
if value is None: # get
1569
return dbus.UInt64(self.interval_milliseconds())
2107
return dbus.UInt64(self.interval.total_seconds() * 1000)
1570
2108
self.interval = datetime.timedelta(0, 0, 0, value)
1571
2109
if getattr(self, "checker_initiator_tag", None) is None:
1572
2110
return
1573
2111
if self.enabled:
1574
2112
# Reschedule checker run
1575
gobject.source_remove(self.checker_initiator_tag)
1576
self.checker_initiator_tag = (gobject.timeout_add
1577
(value, self.start_checker))
1578
self.start_checker() # Start one now, too
1579
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
1580
2118
# Checker - property
1581
@dbus_service_property(_interface, signature="s",
2119
@dbus_service_property(_interface,
2120
signature="s",
1582
2121
access="readwrite")
1583
2122
def Checker_dbus_property(self, value=None):
1584
2123
if value is None: # get
1585
2124
return dbus.String(self.checker_command)
1586
self.checker_command = unicode(value)
1587
2125
self.checker_command = str(value)
2126
1588
2127
# CheckerRunning - property
1589
@dbus_service_property(_interface, signature="b",
2128
@dbus_service_property(_interface,
2129
signature="b",
1590
2130
access="readwrite")
1591
2131
def CheckerRunning_dbus_property(self, value=None):
1592
2132
if value is None: # get
1595
2135
self.start_checker()
1596
2136
else:
1597
2137
self.stop_checker()
1598
2138
1599
2139
# ObjectPath - property
2140
@dbus_annotations(
2141
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2142
"org.freedesktop.DBus.Deprecated": "true"})
1600
2143
@dbus_service_property(_interface, signature="o", access="read")
1601
2144
def ObjectPath_dbus_property(self):
1602
return self.dbus_object_path # is already a dbus.ObjectPath
1603
2145
return self.dbus_object_path # is already a dbus.ObjectPath
2146
1604
2147
# Secret = property
1605
@dbus_service_property(_interface, signature="ay",
1606
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)
1607
2155
def Secret_dbus_property(self, value):
1608
self.secret = str(value)
1609
2156
self.secret = bytes(value)
2157
1610
2158
del _interface
1611
2159
1612
2160
1615
2163
self._pipe = child_pipe
1616
2164
self._pipe.send(('init', fpr, address))
1617
2165
if not self._pipe.recv():
1618
raise KeyError()
1619
2166
raise KeyError(fpr)
2167
1620
2168
def __getattribute__(self, name):
1621
2169
if name == '_pipe':
1622
2170
return super(ProxyClient, self).__getattribute__(name)
1625
2173
if data[0] == 'data':
1626
2174
return data[1]
1627
2175
if data[0] == 'function':
2176
1628
2177
def func(*args, **kwargs):
1629
2178
self._pipe.send(('funcall', name, args, kwargs))
1630
2179
return self._pipe.recv()[1]
2180
1631
2181
return func
1632
2182
1633
2183
def __setattr__(self, name, value):
1634
2184
if name == '_pipe':
1635
2185
return super(ProxyClient, self).__setattr__(name, value)
1638
2188
1639
2189
class ClientHandler(socketserver.BaseRequestHandler, object):
1640
2190
"""A class to handle client connections.
1641
2191
1642
2192
Instantiated once for each connection to handle it.
1643
2193
Note: This will run in its own forked process."""
1644
2194
1645
2195
def handle(self):
1646
2196
with contextlib.closing(self.server.child_pipe) as child_pipe:
1647
2197
logger.info("TCP connection from: %s",
1648
unicode(self.client_address))
2198
str(self.client_address))
1649
2199
logger.debug("Pipe FD: %d",
1650
2200
self.server.child_pipe.fileno())
1651
1652
session = (gnutls.connection
1653
.ClientSession(self.request,
1654
gnutls.connection
1655
.X509Credentials()))
1656
1657
# Note: gnutls.connection.X509Credentials is really a
1658
# generic GnuTLS certificate credentials object so long as
1659
# no X.509 keys are added to it. Therefore, we can use it
1660
# here despite using OpenPGP certificates.
1661
1662
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1663
# "+AES-256-CBC", "+SHA1",
1664
# "+COMP-NULL", "+CTYPE-OPENPGP",
1665
# "+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"))
1666
2208
# Use a fallback default, since this MUST be set.
1667
2209
priority = self.server.gnutls_priority
1668
2210
if priority is None:
1669
2211
priority = "NORMAL"
1670
(gnutls.library.functions
1671
.gnutls_priority_set_direct(session._c_object,
1672
priority, None))
1673
2212
gnutls.priority_set_direct(session._c_object,
2213
priority.encode("utf-8"),
2214
None)
2215
1674
2216
# Start communication using the Mandos protocol
1675
2217
# Get protocol number
1676
2218
line = self.request.makefile().readline()
1677
2219
logger.debug("Protocol version: %r", line)
1678
2220
try:
1679
2221
if int(line.strip().split()[0]) > 1:
1680
raise RuntimeError
2222
raise RuntimeError(line)
1681
2223
except (ValueError, IndexError, RuntimeError) as error:
1682
2224
logger.error("Unknown protocol version: %s", error)
1683
2225
return
1684
2226
1685
2227
# Start GnuTLS connection
1686
2228
try:
1687
2229
session.handshake()
1688
except gnutls.errors.GNUTLSError as error:
2230
except gnutls.Error as error:
1689
2231
logger.warning("Handshake failed: %s", error)
1690
2232
# Do not run session.bye() here: the session is not
1691
2233
# established. Just abandon the request.
1692
2234
return
1693
2235
logger.debug("Handshake succeeded")
1694
2236
1695
2237
approval_required = False
1696
2238
try:
1697
2239
try:
1698
fpr = self.fingerprint(self.peer_certificate
1699
(session))
1700
except (TypeError,
1701
gnutls.errors.GNUTLSError) as error:
2240
fpr = self.fingerprint(
2241
self.peer_certificate(session))
2242
except (TypeError, gnutls.Error) as error:
1702
2243
logger.warning("Bad certificate: %s", error)
1703
2244
return
1704
2245
logger.debug("Fingerprint: %s", fpr)
1705
2246
1706
2247
try:
1707
2248
client = ProxyClient(child_pipe, fpr,
1708
2249
self.client_address)
1709
2250
except KeyError:
1710
2251
return
1711
2252
1712
2253
if client.approval_delay:
1713
2254
delay = client.approval_delay
1714
2255
client.approvals_pending += 1
1715
2256
approval_required = True
1716
2257
1717
2258
while True:
1718
2259
if not client.enabled:
1719
2260
logger.info("Client %s is disabled",
1720
client.name)
2261
client.name)
1721
2262
if self.server.use_dbus:
1722
2263
# Emit D-Bus signal
1723
2264
client.Rejected("Disabled")
1724
2265
return
1725
2266
1726
2267
if client.approved or not client.approval_delay:
1727
#We are approved or approval is disabled
2268
# We are approved or approval is disabled
1728
2269
break
1729
2270
elif client.approved is None:
1730
2271
logger.info("Client %s needs approval",
1732
2273
if self.server.use_dbus:
1733
2274
# Emit D-Bus signal
1734
2275
client.NeedApproval(
1735
client.approval_delay_milliseconds(),
1736
client.approved_by_default)
2276
client.approval_delay.total_seconds()
2277
* 1000, client.approved_by_default)
1737
2278
else:
1738
2279
logger.warning("Client %s was not approved",
1739
2280
client.name)
1741
2282
# Emit D-Bus signal
1742
2283
client.Rejected("Denied")
1743
2284
return
1744
1745
#wait until timeout or approved
2285
2286
# wait until timeout or approved
1746
2287
time = datetime.datetime.now()
1747
2288
client.changedstate.acquire()
1748
client.changedstate.wait(
1749
float(timedelta_to_milliseconds(delay)
1750
/ 1000))
2289
client.changedstate.wait(delay.total_seconds())
1751
2290
client.changedstate.release()
1752
2291
time2 = datetime.datetime.now()
1753
2292
if (time2 - time) >= delay:
1763
2302
break
1764
2303
else:
1765
2304
delay -= time2 - time
1766
1767
sent_size = 0
1768
while sent_size < len(client.secret):
1769
try:
1770
sent = session.send(client.secret[sent_size:])
1771
except gnutls.errors.GNUTLSError as error:
1772
logger.warning("gnutls send failed",
1773
exc_info=error)
1774
return
1775
logger.debug("Sent: %d, remaining: %d",
1776
sent, len(client.secret)
1777
- (sent_size + sent))
1778
sent_size += sent
1779
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
1780
2313
logger.info("Sending secret to %s", client.name)
1781
2314
# bump the timeout using extended_timeout
1782
2315
client.bump_timeout(client.extended_timeout)
1783
2316
if self.server.use_dbus:
1784
2317
# Emit D-Bus signal
1785
2318
client.GotSecret()
1786
2319
1787
2320
finally:
1788
2321
if approval_required:
1789
2322
client.approvals_pending -= 1
1790
2323
try:
1791
2324
session.bye()
1792
except gnutls.errors.GNUTLSError as error:
2325
except gnutls.Error as error:
1793
2326
logger.warning("GnuTLS bye failed",
1794
2327
exc_info=error)
1795
2328
1796
2329
@staticmethod
1797
2330
def peer_certificate(session):
1798
2331
"Return the peer's OpenPGP certificate as a bytestring"
1799
2332
# If not an OpenPGP certificate...
1800
if (gnutls.library.functions
1801
.gnutls_certificate_type_get(session._c_object)
1802
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1803
# ...do the normal thing
1804
return session.peer_certificate
2333
if (gnutls.certificate_type_get(session._c_object)
2334
!= gnutls.CRT_OPENPGP):
2335
# ...return invalid data
2336
return b""
1805
2337
list_size = ctypes.c_uint(1)
1806
cert_list = (gnutls.library.functions
1807
.gnutls_certificate_get_peers
2338
cert_list = (gnutls.certificate_get_peers
1808
2339
(session._c_object, ctypes.byref(list_size)))
1809
2340
if not bool(cert_list) and list_size.value != 0:
1810
raise gnutls.errors.GNUTLSError("error getting peer"
1811
" certificate")
2341
raise gnutls.Error("error getting peer certificate")
1812
2342
if list_size.value == 0:
1813
2343
return None
1814
2344
cert = cert_list[0]
1815
2345
return ctypes.string_at(cert.data, cert.size)
1816
2346
1817
2347
@staticmethod
1818
2348
def fingerprint(openpgp):
1819
2349
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1820
2350
# New GnuTLS "datum" with the OpenPGP public key
1821
datum = (gnutls.library.types
1822
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1823
ctypes.POINTER
1824
(ctypes.c_ubyte)),
1825
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)))
1826
2355
# New empty GnuTLS certificate
1827
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1828
(gnutls.library.functions
1829
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2356
crt = gnutls.openpgp_crt_t()
2357
gnutls.openpgp_crt_init(ctypes.byref(crt))
1830
2358
# Import the OpenPGP public key into the certificate
1831
(gnutls.library.functions
1832
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1833
gnutls.library.constants
1834
.GNUTLS_OPENPGP_FMT_RAW))
2359
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2360
gnutls.OPENPGP_FMT_RAW)
1835
2361
# Verify the self signature in the key
1836
2362
crtverify = ctypes.c_uint()
1837
(gnutls.library.functions
1838
.gnutls_openpgp_crt_verify_self(crt, 0,
1839
ctypes.byref(crtverify)))
2363
gnutls.openpgp_crt_verify_self(crt, 0,
2364
ctypes.byref(crtverify))
1840
2365
if crtverify.value != 0:
1841
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1842
raise (gnutls.errors.CertificateSecurityError
1843
("Verify failed"))
2366
gnutls.openpgp_crt_deinit(crt)
2367
raise gnutls.CertificateSecurityError("Verify failed")
1844
2368
# New buffer for the fingerprint
1845
2369
buf = ctypes.create_string_buffer(20)
1846
2370
buf_len = ctypes.c_size_t()
1847
2371
# Get the fingerprint from the certificate into the buffer
1848
(gnutls.library.functions
1849
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1850
ctypes.byref(buf_len)))
2372
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2373
ctypes.byref(buf_len))
1851
2374
# Deinit the certificate
1852
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2375
gnutls.openpgp_crt_deinit(crt)
1853
2376
# Convert the buffer to a Python bytestring
1854
2377
fpr = ctypes.string_at(buf, buf_len.value)
1855
2378
# Convert the bytestring to hexadecimal notation
1859
2382
1860
2383
class MultiprocessingMixIn(object):
1861
2384
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2385
1862
2386
def sub_process_main(self, request, address):
1863
2387
try:
1864
2388
self.finish_request(request, address)
1865
2389
except Exception:
1866
2390
self.handle_error(request, address)
1867
2391
self.close_request(request)
1868
2392
1869
2393
def process_request(self, request, address):
1870
2394
"""Start a new process to process the request."""
1871
proc = multiprocessing.Process(target = self.sub_process_main,
1872
args = (request, address))
2395
proc = multiprocessing.Process(target=self.sub_process_main,
2396
args=(request, address))
1873
2397
proc.start()
1874
2398
return proc
1875
2399
1876
2400
1877
2401
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1878
2402
""" adds a pipe to the MixIn """
2403
1879
2404
def process_request(self, request, client_address):
1880
2405
"""Overrides and wraps the original process_request().
1881
2406
1882
2407
This function creates a new pipe in self.pipe
1883
2408
"""
1884
2409
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1885
2410
1886
2411
proc = MultiprocessingMixIn.process_request(self, request,
1887
2412
client_address)
1888
2413
self.child_pipe.close()
1889
2414
self.add_pipe(parent_pipe, proc)
1890
2415
1891
2416
def add_pipe(self, parent_pipe, proc):
1892
2417
"""Dummy function; override as necessary"""
1893
raise NotImplementedError
2418
raise NotImplementedError()
1894
2419
1895
2420
1896
2421
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1897
2422
socketserver.TCPServer, object):
1898
2423
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1899
2424
1900
2425
Attributes:
1901
2426
enabled: Boolean; whether this server is activated yet
1902
2427
interface: None or a network interface name (string)
1903
2428
use_ipv6: Boolean; to use IPv6 or not
1904
2429
"""
2430
1905
2431
def __init__(self, server_address, RequestHandlerClass,
1906
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
"""
1907
2438
self.interface = interface
1908
2439
if use_ipv6:
1909
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.
1910
2468
socketserver.TCPServer.__init__(self, server_address,
1911
2469
RequestHandlerClass)
2470
1912
2471
def server_bind(self):
1913
2472
"""This overrides the normal server_bind() function
1914
2473
to bind to an interface if one was specified, and also NOT to
1915
2474
bind to an address or port if they were not specified."""
2475
global SO_BINDTODEVICE
1916
2476
if self.interface is not None:
1917
2477
if SO_BINDTODEVICE is None:
1918
logger.error("SO_BINDTODEVICE does not exist;"
1919
" cannot bind to interface %s",
1920
self.interface)
1921
else:
1922
try:
1923
self.socket.setsockopt(socket.SOL_SOCKET,
1924
SO_BINDTODEVICE,
1925
str(self.interface
1926
+ '\0'))
1927
except socket.error as error:
1928
if error[0] == errno.EPERM:
1929
logger.error("No permission to"
1930
" bind to interface %s",
1931
self.interface)
1932
elif error[0] == errno.ENOPROTOOPT:
1933
logger.error("SO_BINDTODEVICE not available;"
1934
" cannot bind to interface %s",
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:
2291
if error[0] != errno.EPERM:
2292
raise error
2293
3009
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3010
.format(uid, gid, os.strerror(error.errno)))
3011
if error.errno != errno.EPERM:
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
signal.signal(signal.SIGINT, signal.SIG_IGN)
2466
2467
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2468
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2469
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
2470
3250
if use_dbus:
2471
@alternate_dbus_interfaces({"se.recompile.Mandos":
2472
"se.bsnet.fukt.Mandos"})
2473
class MandosDBusService(DBusObjectWithProperties):
3251
3252
@alternate_dbus_interfaces(
3253
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3254
class MandosDBusService(DBusObjectWithObjectManager):
2474
3255
"""A D-Bus proxy object"""
3256
2475
3257
def __init__(self):
2476
3258
dbus.service.Object.__init__(self, bus, "/")
3259
2477
3260
_interface = "se.recompile.Mandos"
2478
2479
@dbus_interface_annotations(_interface)
2480
def _foo(self):
2481
return { "org.freedesktop.DBus.Property"
2482
".EmitsChangedSignal":
2483
"false"}
2484
3261
2485
3262
@dbus.service.signal(_interface, signature="o")
2486
3263
def ClientAdded(self, objpath):
2487
3264
"D-Bus signal"
2488
3265
pass
2489
3266
2490
3267
@dbus.service.signal(_interface, signature="ss")
2491
3268
def ClientNotFound(self, fingerprint, address):
2492
3269
"D-Bus signal"
2493
3270
pass
2494
3271
3272
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3273
"true"})
2495
3274
@dbus.service.signal(_interface, signature="os")
2496
3275
def ClientRemoved(self, objpath, name):
2497
3276
"D-Bus signal"
2498
3277
pass
2499
3278
3279
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3280
"true"})
2500
3281
@dbus.service.method(_interface, out_signature="ao")
2501
3282
def GetAllClients(self):
2502
3283
"D-Bus method"
2503
return dbus.Array(c.dbus_object_path
2504
for c in
2505
tcp_server.clients.itervalues())
2506
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"})
2507
3289
@dbus.service.method(_interface,
2508
3290
out_signature="a{oa{sv}}")
2509
3291
def GetAllClientsWithProperties(self):
2510
3292
"D-Bus method"
2511
3293
return dbus.Dictionary(
2512
((c.dbus_object_path, c.GetAll(""))
2513
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()},
2514
3297
signature="oa{sv}")
2515
3298
2516
3299
@dbus.service.method(_interface, in_signature="o")
2517
3300
def RemoveClient(self, object_path):
2518
3301
"D-Bus method"
2519
for c in tcp_server.clients.itervalues():
3302
for c in tcp_server.clients.values():
2520
3303
if c.dbus_object_path == object_path:
2521
3304
del tcp_server.clients[c.name]
2522
3305
c.remove_from_connection()
2523
# Don't signal anything except ClientRemoved
3306
# Don't signal the disabling
2524
3307
c.disable(quiet=True)
2525
# Emit D-Bus signal
2526
self.ClientRemoved(object_path, c.name)
3308
# Emit D-Bus signal for removal
3309
self.client_removed_signal(c)
2527
3310
return
2528
3311
raise KeyError(object_path)
2529
3312
2530
3313
del _interface
2531
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
2532
3351
mandos_dbus_service = MandosDBusService()
2533
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
2534
3358
def cleanup():
2535
3359
"Cleanup function; run on exit"
2536
service.cleanup()
2537
2538
multiprocessing.active_children()
3360
if zeroconf:
3361
service.cleanup()
3362
3363
mp.active_children()
3364
wn.close()
2539
3365
if not (tcp_server.clients or client_settings):
2540
3366
return
2541
3367
2542
3368
# Store client before exiting. Secrets are encrypted with key
2543
3369
# based on what config file has. If config file is
2544
3370
# removed/edited, old secret will thus be unrecovable.
2545
3371
clients = {}
2546
3372
with PGPEngine() as pgp:
2547
for client in tcp_server.clients.itervalues():
3373
for client in tcp_server.clients.values():
2548
3374
key = client_settings[client.name]["secret"]
2549
3375
client.encrypted_secret = pgp.encrypt(client.secret,
2550
3376
key)
2551
3377
client_dict = {}
2552
3378
2553
3379
# A list of attributes that can not be pickled
2554
3380
# + secret.
2555
exclude = set(("bus", "changedstate", "secret",
2556
"checker"))
2557
for name, typ in (inspect.getmembers
2558
(dbus.service.Object)):
3381
exclude = {"bus", "changedstate", "secret",
3382
"checker", "server_settings"}
3383
for name, typ in inspect.getmembers(dbus.service
3384
.Object):
2559
3385
exclude.add(name)
2560
3386
2561
3387
client_dict["encrypted_secret"] = (client
2562
3388
.encrypted_secret)
2563
3389
for attr in client.client_structure:
2564
3390
if attr not in exclude:
2565
3391
client_dict[attr] = getattr(client, attr)
2566
3392
2567
3393
clients[client.name] = client_dict
2568
3394
del client_settings[client.name]["secret"]
2569
3395
2570
3396
try:
2571
with (tempfile.NamedTemporaryFile
2572
(mode='wb', suffix=".pickle", prefix='clients-',
2573
dir=os.path.dirname(stored_state_path),
2574
delete=False)) as stored_state:
2575
pickle.dump((clients, client_settings), stored_state)
2576
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
2577
3406
os.rename(tempname, stored_state_path)
2578
3407
except (IOError, OSError) as e:
2579
3408
if not debug:
2582
3411
except NameError:
2583
3412
pass
2584
3413
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2585
logger.warning("Could not save persistent state: {0}"
3414
logger.warning("Could not save persistent state: {}"
2586
3415
.format(os.strerror(e.errno)))
2587
3416
else:
2588
3417
logger.warning("Could not save persistent state:",
2589
3418
exc_info=e)
2590
raise e
2591
3419
raise
3420
2592
3421
# Delete all clients, and settings from config
2593
3422
while tcp_server.clients:
2594
3423
name, client = tcp_server.clients.popitem()
2595
3424
if use_dbus:
2596
3425
client.remove_from_connection()
2597
# Don't signal anything except ClientRemoved
3426
# Don't signal the disabling
2598
3427
client.disable(quiet=True)
3428
# Emit D-Bus signal for removal
2599
3429
if use_dbus:
2600
# Emit D-Bus signal
2601
mandos_dbus_service.ClientRemoved(client
2602
.dbus_object_path,
2603
client.name)
3430
mandos_dbus_service.client_removed_signal(client)
2604
3431
client_settings.clear()
2605
3432
2606
3433
atexit.register(cleanup)
2607
2608
for client in tcp_server.clients.itervalues():
3434
3435
for client in tcp_server.clients.values():
2609
3436
if use_dbus:
2610
# Emit D-Bus signal
2611
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3437
# Emit D-Bus signal for adding
3438
mandos_dbus_service.client_added_signal(client)
2612
3439
# Need to initiate checking of clients
2613
3440
if client.enabled:
2614
3441
client.init_checker()
2615
3442
2616
3443
tcp_server.enable()
2617
3444
tcp_server.server_activate()
2618
3445
2619
3446
# Find out what port we got
2620
service.port = tcp_server.socket.getsockname()[1]
3447
if zeroconf:
3448
service.port = tcp_server.socket.getsockname()[1]
2621
3449
if use_ipv6:
2622
3450
logger.info("Now listening on address %r, port %d,"
2623
3451
" flowinfo %d, scope_id %d",
2625
3453
else: # IPv4
2626
3454
logger.info("Now listening on address %r, port %d",
2627
3455
*tcp_server.socket.getsockname())
2628
2629
#service.interface = tcp_server.socket.getsockname()[3]
2630
3456
3457
# service.interface = tcp_server.socket.getsockname()[3]
3458
2631
3459
try:
2632
# From the Avahi example code
2633
try:
2634
service.activate()
2635
except dbus.exceptions.DBusException as error:
2636
logger.critical("D-Bus Exception", exc_info=error)
2637
cleanup()
2638
sys.exit(1)
2639
# End of Avahi example code
2640
2641
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2642
lambda *args, **kwargs:
2643
(tcp_server.handle_request
2644
(*args[2:], **kwargs) or True))
2645
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
2646
3475
logger.debug("Starting main loop")
2647
3476
main_loop.run()
2648
3477
except AvahiError as error:
2657
3486
# Must run before the D-Bus bus name gets deregistered
2658
3487
cleanup()
2659
3488
3489
2660
3490
if __name__ == '__main__':
2661
3491
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0