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