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