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