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