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