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