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