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