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