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