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