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