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