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