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