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