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