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