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