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