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