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