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