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