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.16"
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["fingerprint"].upper()
965
.replace(" ", ""))
966
if "secret" in section:
967
client["secret"] = codecs.decode(section["secret"]
968
.encode("utf-8"),
969
"base64")
970
elif "secfile" in section:
971
with open(os.path.expanduser(os.path.expandvars
972
(section["secfile"])),
973
"rb") as secfile:
974
client["secret"] = secfile.read()
975
else:
976
raise TypeError("No secret or secfile for section {}"
977
.format(section))
978
client["timeout"] = string_to_delta(section["timeout"])
979
client["extended_timeout"] = string_to_delta(
980
section["extended_timeout"])
981
client["interval"] = string_to_delta(section["interval"])
982
client["approval_delay"] = string_to_delta(
983
section["approval_delay"])
984
client["approval_duration"] = string_to_delta(
985
section["approval_duration"])
986
client["checker_command"] = section["checker"]
987
client["last_approval_request"] = None
988
client["last_checked_ok"] = None
989
client["last_checker_status"] = -2
990
991
return settings
992
993
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."""
994
454
self.name = name
995
if server_settings is None:
996
server_settings = {}
997
self.server_settings = server_settings
998
# adding all client settings
999
for setting, value in settings.items():
1000
setattr(self, setting, value)
1001
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
1002
478
if self.enabled:
1003
if not hasattr(self, "last_enabled"):
1004
self.last_enabled = datetime.datetime.utcnow()
1005
if not hasattr(self, "expires"):
1006
self.expires = (datetime.datetime.utcnow()
1007
+ self.timeout)
479
self.last_enabled = datetime.datetime.utcnow()
1008
480
else:
1009
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:
1010
494
self.expires = None
1011
1012
log.debug("Creating client %r", self.name)
1013
log.debug(" Key ID: %s", self.key_id)
1014
log.debug(" Fingerprint: %s", self.fingerprint)
1015
self.created = settings.get("created",
1016
datetime.datetime.utcnow())
1017
1018
# attributes specific for this server instance
1019
self.checker = None
1020
self.checker_initiator_tag = None
1021
self.disable_initiator_tag = None
1022
495
self.checker_callback_tag = None
496
self.checker_command = config["checker"]
1023
497
self.current_checker_command = None
1024
self.approved = None
498
self._approved = None
499
self.approved_by_default = config.get("approved_by_default",
500
True)
1025
501
self.approvals_pending = 0
1026
self.changedstate = multiprocessing_manager.Condition(
1027
multiprocessing_manager.Lock())
1028
self.client_structure = [attr
1029
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()
1030
511
if not attr.startswith("_")]
1031
512
self.client_structure.append("client_structure")
1032
1033
for name, t in inspect.getmembers(
1034
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)):
1035
518
if not name.startswith("_"):
1036
519
self.client_structure.append(name)
1037
520
1038
521
# Send notice to process children that client state has changed
1039
522
def send_changedstate(self):
1040
523
with self.changedstate:
1041
524
self.changedstate.notify_all()
1042
525
1043
526
def enable(self):
1044
527
"""Start this client's checker and timeout hooks"""
1045
528
if getattr(self, "enabled", False):
1046
529
# Already enabled
1047
530
return
531
self.send_changedstate()
532
self.expires = datetime.datetime.utcnow() + self.timeout
1048
533
self.enabled = True
1049
534
self.last_enabled = datetime.datetime.utcnow()
1050
535
self.init_checker()
1051
self.send_changedstate()
1052
536
1053
537
def disable(self, quiet=True):
1054
538
"""Disable this client."""
1055
539
if not getattr(self, "enabled", False):
1056
540
return False
1057
541
if not quiet:
1058
log.info("Disabling client %s", self.name)
1059
if getattr(self, "disable_initiator_tag", None) is not None:
1060
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)
1061
547
self.disable_initiator_tag = None
1062
548
self.expires = None
1063
if getattr(self, "checker_initiator_tag", None) is not None:
1064
GLib.source_remove(self.checker_initiator_tag)
549
if getattr(self, "checker_initiator_tag", False):
550
gobject.source_remove(self.checker_initiator_tag)
1065
551
self.checker_initiator_tag = None
1066
552
self.stop_checker()
1067
553
self.enabled = False
1068
if not quiet:
1069
self.send_changedstate()
1070
# 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
1071
555
return False
1072
556
1073
557
def __del__(self):
1074
558
self.disable()
1075
1076
def init_checker(self, randomize_start=False):
1077
# Schedule a new checker to be started a randomly selected
1078
# time (a fraction of 'interval') from now. This spreads out
1079
# the startup of checkers over time when the server is
1080
# started.
1081
if self.checker_initiator_tag is not None:
1082
GLib.source_remove(self.checker_initiator_tag)
1083
interval_milliseconds = int(self.interval.total_seconds()
1084
* 1000)
1085
if randomize_start:
1086
delay_milliseconds = random.randrange(
1087
interval_milliseconds + 1)
1088
else:
1089
delay_milliseconds = interval_milliseconds
1090
self.checker_initiator_tag = GLib.timeout_add(
1091
delay_milliseconds, self.start_checker, randomize_start)
1092
delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1093
# A checker might take up to an 'interval' of time, so we can
1094
# expire at the soonest one interval after a checker was
1095
# started. Since the initial checker is delayed, the expire
1096
# time might have to be extended.
1097
now = datetime.datetime.utcnow()
1098
self.expires = now + delay + self.interval
1099
# Schedule a disable() at expire time
1100
if self.disable_initiator_tag is not None:
1101
GLib.source_remove(self.disable_initiator_tag)
1102
self.disable_initiator_tag = GLib.timeout_add(
1103
int((self.expires - now).total_seconds() * 1000),
1104
self.disable)
1105
1106
def checker_callback(self, source, condition, connection,
1107
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):
1108
574
"""The checker has completed, so take appropriate actions."""
1109
# Read return code from connection (see call_pipe)
1110
returncode = connection.recv()
1111
connection.close()
1112
if self.checker is not None:
1113
self.checker.join()
1114
575
self.checker_callback_tag = None
1115
576
self.checker = None
1116
1117
if returncode >= 0:
1118
self.last_checker_status = returncode
1119
self.last_checker_signal = None
577
if os.WIFEXITED(condition):
578
self.last_checker_status = os.WEXITSTATUS(condition)
1120
579
if self.last_checker_status == 0:
1121
log.info("Checker for %(name)s succeeded", vars(self))
580
logger.info("Checker for %(name)s succeeded",
581
vars(self))
1122
582
self.checked_ok()
1123
583
else:
1124
log.info("Checker for %(name)s failed", vars(self))
584
logger.info("Checker for %(name)s failed",
585
vars(self))
1125
586
else:
1126
587
self.last_checker_status = -1
1127
self.last_checker_signal = -returncode
1128
log.warning("Checker for %(name)s crashed?", vars(self))
1129
return False
1130
1131
def checked_ok(self):
1132
"""Assert that the client has been seen, alive and well."""
1133
self.last_checked_ok = datetime.datetime.utcnow()
1134
self.last_checker_status = 0
1135
self.last_checker_signal = None
1136
self.bump_timeout()
1137
1138
def bump_timeout(self, timeout=None):
1139
"""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
"""
1140
597
if timeout is None:
1141
598
timeout = self.timeout
599
self.last_checked_ok = datetime.datetime.utcnow()
1142
600
if self.disable_initiator_tag is not None:
1143
GLib.source_remove(self.disable_initiator_tag)
1144
self.disable_initiator_tag = None
601
gobject.source_remove(self.disable_initiator_tag)
1145
602
if getattr(self, "enabled", False):
1146
self.disable_initiator_tag = GLib.timeout_add(
1147
int(timeout.total_seconds() * 1000), self.disable)
603
self.disable_initiator_tag = (gobject.timeout_add
604
(_timedelta_to_milliseconds
605
(timeout), self.disable))
1148
606
self.expires = datetime.datetime.utcnow() + timeout
1149
607
1150
608
def need_approval(self):
1151
609
self.last_approval_request = datetime.datetime.utcnow()
1152
1153
def start_checker(self, start_was_randomized=False):
610
611
def start_checker(self):
1154
612
"""Start a new checker subprocess if one is not running.
1155
613
1156
614
If a checker already exists, leave it running and do
1157
615
nothing."""
1158
616
# The reason for not killing a running checker is that if we
1159
# did that, and if a checker (for some reason) started running
1160
# slowly and taking more than 'interval' time, then the client
1161
# would inevitably timeout, since no checker would get a
1162
# 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
1163
621
# checkers alone, the checker would have to take more time
1164
622
# than 'timeout' for the client to be disabled, which is as it
1165
623
# should be.
1166
1167
if self.checker is not None and not self.checker.is_alive():
1168
log.warning("Checker was not alive; joining")
1169
self.checker.join()
1170
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)
1171
638
# Start a new checker if needed
1172
639
if self.checker is None:
1173
# Escape attributes for the shell
1174
escaped_attrs = {
1175
attr: shlex.quote(str(getattr(self, attr)))
1176
for attr in self.runtime_expansions}
1177
640
try:
1178
command = self.checker_command % escaped_attrs
1179
except TypeError as error:
1180
log.error('Could not format string "%s"',
1181
self.checker_command, exc_info=error)
1182
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
1183
659
self.current_checker_command = command
1184
log.info("Starting checker %r for %s", command, self.name)
1185
# We don't need to redirect stdout and stderr, since
1186
# in normal mode, that is already done by daemon(),
1187
# and in debug mode we don't want to. (Stdin is
1188
# always replaced by /dev/null.)
1189
# The exception is when not debugging but nevertheless
1190
# running in the foreground; use the previously
1191
# created wnull.
1192
popen_args = {"close_fds": True,
1193
"shell": True,
1194
"cwd": "/"}
1195
if (not self.server_settings["debug"]
1196
and self.server_settings["foreground"]):
1197
popen_args.update({"stdout": wnull,
1198
"stderr": wnull})
1199
pipe = multiprocessing.Pipe(duplex=False)
1200
self.checker = multiprocessing.Process(
1201
target=call_pipe,
1202
args=(pipe[1], subprocess.call, command),
1203
kwargs=popen_args)
1204
self.checker.start()
1205
self.checker_callback_tag = GLib.io_add_watch(
1206
GLib.IOChannel.unix_new(pipe[0].fileno()),
1207
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1208
self.checker_callback, pipe[0], command)
1209
if start_was_randomized:
1210
# We were started after a random delay; Schedule a new
1211
# checker to be started an 'interval' from now, and every
1212
# interval from then on.
1213
now = datetime.datetime.utcnow()
1214
self.checker_initiator_tag = GLib.timeout_add(
1215
int(self.interval.total_seconds() * 1000),
1216
self.start_checker)
1217
self.expires = max(self.expires, now + self.interval)
1218
# Don't start a new checker again after same random delay
1219
return False
1220
# 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
1221
684
return True
1222
685
1223
686
def stop_checker(self):
1224
687
"""Force the checker process, if any, to stop."""
1225
688
if self.checker_callback_tag:
1226
GLib.source_remove(self.checker_callback_tag)
689
gobject.source_remove(self.checker_callback_tag)
1227
690
self.checker_callback_tag = None
1228
691
if getattr(self, "checker", None) is None:
1229
692
return
1230
log.debug("Stopping checker for %(name)s", vars(self))
1231
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
1232
702
self.checker = None
1233
703
1234
704
1235
def dbus_service_property(dbus_interface,
1236
signature="v",
1237
access="readwrite",
1238
byte_arrays=False):
705
def dbus_service_property(dbus_interface, signature="v",
706
access="readwrite", byte_arrays=False):
1239
707
"""Decorators for marking methods of a DBusObjectWithProperties to
1240
708
become properties on the D-Bus.
1241
709
1242
710
The decorated method will be called with no arguments by "Get"
1243
711
and with one argument by "Set".
1244
712
1245
713
The parameters, where they are supported, are the same as
1246
714
dbus.service.method, except there is only "signature", since the
1247
715
type from Get() and the type sent to Set() is the same.
1250
718
# "Set" method, so we fail early here:
1251
719
if byte_arrays and signature != "ay":
1252
720
raise ValueError("Byte arrays not supported for non-'ay'"
1253
" signature {!r}".format(signature))
1254
721
" signature %r" % signature)
1255
722
def decorator(func):
1256
723
func._dbus_is_property = True
1257
724
func._dbus_interface = dbus_interface
1260
727
func._dbus_name = func.__name__
1261
728
if func._dbus_name.endswith("_dbus_property"):
1262
729
func._dbus_name = func._dbus_name[:-14]
1263
func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1264
return func
1265
1266
return decorator
1267
1268
1269
def dbus_interface_annotations(dbus_interface):
1270
"""Decorator for marking functions returning interface annotations
1271
1272
Usage:
1273
1274
@dbus_interface_annotations("org.example.Interface")
1275
def _foo(self): # Function name does not matter
1276
return {"org.freedesktop.DBus.Deprecated": "true",
1277
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1278
"false"}
1279
"""
1280
1281
def decorator(func):
1282
func._dbus_is_interface = True
1283
func._dbus_interface = dbus_interface
1284
func._dbus_name = dbus_interface
1285
return func
1286
1287
return decorator
1288
1289
1290
def dbus_annotations(annotations):
1291
"""Decorator to annotate D-Bus methods, signals or properties
1292
Usage:
1293
1294
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1295
"org.freedesktop.DBus.Property."
1296
"EmitsChangedSignal": "false"})
1297
@dbus_service_property("org.example.Interface", signature="b",
1298
access="r")
1299
def Property_dbus_property(self):
1300
return dbus.Boolean(False)
1301
1302
See also the DBusObjectWithAnnotations class.
1303
"""
1304
1305
def decorator(func):
1306
func._dbus_annotations = annotations
1307
return func
1308
730
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
731
return func
1309
732
return decorator
1310
733
1311
734
1312
735
class DBusPropertyException(dbus.exceptions.DBusException):
1313
736
"""A base class for D-Bus property-related exceptions
1314
737
"""
1315
pass
738
def __unicode__(self):
739
return unicode(str(self))
1316
740
1317
741
1318
742
class DBusPropertyAccessException(DBusPropertyException):
1327
751
pass
1328
752
1329
753
1330
class DBusObjectWithAnnotations(dbus.service.Object):
1331
"""A D-Bus object with annotations.
1332
1333
Classes inheriting from this can use the dbus_annotations
1334
decorator to add annotations to methods or signals.
1335
"""
1336
1337
@staticmethod
1338
def _is_dbus_thing(thing):
1339
"""Returns a function testing if an attribute is a D-Bus thing
1340
1341
If called like _is_dbus_thing("method") it returns a function
1342
suitable for use as predicate to inspect.getmembers().
1343
"""
1344
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1345
False)
1346
1347
def _get_all_dbus_things(self, thing):
1348
"""Returns a generator of (name, attribute) pairs
1349
"""
1350
return ((getattr(athing.__get__(self), "_dbus_name", name),
1351
athing.__get__(self))
1352
for cls in self.__class__.__mro__
1353
for name, athing in
1354
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1355
1356
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1357
out_signature="s",
1358
path_keyword="object_path",
1359
connection_keyword="connection")
1360
def Introspect(self, object_path, connection):
1361
"""Overloading of standard D-Bus method.
1362
1363
Inserts annotation tags on methods and signals.
1364
"""
1365
xmlstring = dbus.service.Object.Introspect(self, object_path,
1366
connection)
1367
try:
1368
document = xml.dom.minidom.parseString(xmlstring)
1369
1370
for if_tag in document.getElementsByTagName("interface"):
1371
# Add annotation tags
1372
for typ in ("method", "signal"):
1373
for tag in if_tag.getElementsByTagName(typ):
1374
annots = dict()
1375
for name, prop in (self.
1376
_get_all_dbus_things(typ)):
1377
if (name == tag.getAttribute("name")
1378
and prop._dbus_interface
1379
== if_tag.getAttribute("name")):
1380
annots.update(getattr(
1381
prop, "_dbus_annotations", {}))
1382
for name, value in annots.items():
1383
ann_tag = document.createElement(
1384
"annotation")
1385
ann_tag.setAttribute("name", name)
1386
ann_tag.setAttribute("value", value)
1387
tag.appendChild(ann_tag)
1388
# Add interface annotation tags
1389
for annotation, value in dict(
1390
itertools.chain.from_iterable(
1391
annotations().items()
1392
for name, annotations
1393
in self._get_all_dbus_things("interface")
1394
if name == if_tag.getAttribute("name")
1395
)).items():
1396
ann_tag = document.createElement("annotation")
1397
ann_tag.setAttribute("name", annotation)
1398
ann_tag.setAttribute("value", value)
1399
if_tag.appendChild(ann_tag)
1400
# Fix argument name for the Introspect method itself
1401
if (if_tag.getAttribute("name")
1402
== dbus.INTROSPECTABLE_IFACE):
1403
for cn in if_tag.getElementsByTagName("method"):
1404
if cn.getAttribute("name") == "Introspect":
1405
for arg in cn.getElementsByTagName("arg"):
1406
if (arg.getAttribute("direction")
1407
== "out"):
1408
arg.setAttribute("name",
1409
"xml_data")
1410
xmlstring = document.toxml("utf-8")
1411
document.unlink()
1412
except (AttributeError, xml.dom.DOMException,
1413
xml.parsers.expat.ExpatError) as error:
1414
log.error("Failed to override Introspection method",
1415
exc_info=error)
1416
return xmlstring
1417
1418
1419
class DBusObjectWithProperties(DBusObjectWithAnnotations):
754
class DBusObjectWithProperties(dbus.service.Object):
1420
755
"""A D-Bus object with properties.
1421
756
1422
757
Classes inheriting from this can use the dbus_service_property
1423
758
decorator to expose methods as D-Bus properties. It exposes the
1424
759
standard Get(), Set(), and GetAll() methods on the D-Bus.
1425
760
"""
1426
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
1427
774
def _get_dbus_property(self, interface_name, property_name):
1428
775
"""Returns a bound method if one exists which is a D-Bus
1429
776
property with the specified name and interface.
1430
777
"""
1431
for cls in self.__class__.__mro__:
1432
for name, value in inspect.getmembers(
1433
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)):
1434
781
if (value._dbus_name == property_name
1435
782
and value._dbus_interface == interface_name):
1436
783
return value.__get__(self)
1437
784
1438
785
# No such property
1439
raise DBusPropertyNotFound("{}:{}.{}".format(
1440
self.dbus_object_path, interface_name, property_name))
1441
1442
@classmethod
1443
def _get_all_interface_names(cls):
1444
"""Get a sequence of all interfaces supported by an object"""
1445
return (name for name in set(getattr(getattr(x, attr),
1446
"_dbus_interface", None)
1447
for x in (inspect.getmro(cls))
1448
for attr in dir(x))
1449
if name is not None)
1450
1451
@dbus.service.method(dbus.PROPERTIES_IFACE,
1452
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",
1453
791
out_signature="v")
1454
792
def Get(self, interface_name, property_name):
1455
793
"""Standard D-Bus property Get() method, see D-Bus standard.
1461
799
if not hasattr(value, "variant_level"):
1462
800
return value
1463
801
return type(value)(value, variant_level=value.variant_level+1)
1464
802
1465
803
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1466
804
def Set(self, interface_name, property_name, value):
1467
805
"""Standard D-Bus property Set() method, see D-Bus standard.
1473
811
# The byte_arrays option is not supported yet on
1474
812
# signatures other than "ay".
1475
813
if prop._dbus_signature != "ay":
1476
raise ValueError("Byte arrays not supported for non-"
1477
"'ay' signature {!r}"
1478
.format(prop._dbus_signature))
1479
value = dbus.ByteArray(bytes(value))
814
raise ValueError
815
value = dbus.ByteArray(''.join(unichr(byte)
816
for byte in value))
1480
817
prop(value)
1481
1482
@dbus.service.method(dbus.PROPERTIES_IFACE,
1483
in_signature="s",
818
819
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1484
820
out_signature="a{sv}")
1485
821
def GetAll(self, interface_name):
1486
822
"""Standard D-Bus property GetAll() method, see D-Bus
1487
823
standard.
1488
824
1489
825
Note: Will not include properties with access="write".
1490
826
"""
1491
827
properties = {}
1492
for name, prop in self._get_all_dbus_things("property"):
828
for name, prop in self._get_all_dbus_properties():
1493
829
if (interface_name
1494
830
and interface_name != prop._dbus_interface):
1495
831
# Interface non-empty but did not match
1501
837
if not hasattr(value, "variant_level"):
1502
838
properties[name] = value
1503
839
continue
1504
properties[name] = type(value)(
1505
value, variant_level=value.variant_level + 1)
840
properties[name] = type(value)(value, variant_level=
841
value.variant_level+1)
1506
842
return dbus.Dictionary(properties, signature="sv")
1507
1508
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1509
def PropertiesChanged(self, interface_name, changed_properties,
1510
invalidated_properties):
1511
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1512
standard.
1513
"""
1514
pass
1515
843
1516
844
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1517
845
out_signature="s",
1518
path_keyword="object_path",
1519
connection_keyword="connection")
846
path_keyword='object_path',
847
connection_keyword='connection')
1520
848
def Introspect(self, object_path, connection):
1521
"""Overloading of standard D-Bus method.
1522
1523
Inserts property tags and interface annotation tags.
849
"""Standard D-Bus method, overloaded to insert property tags.
1524
850
"""
1525
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1526
object_path,
1527
connection)
851
xmlstring = dbus.service.Object.Introspect(self, object_path,
852
connection)
1528
853
try:
1529
854
document = xml.dom.minidom.parseString(xmlstring)
1530
1531
855
def make_tag(document, name, prop):
1532
856
e = document.createElement("property")
1533
857
e.setAttribute("name", name)
1534
858
e.setAttribute("type", prop._dbus_signature)
1535
859
e.setAttribute("access", prop._dbus_access)
1536
860
return e
1537
1538
861
for if_tag in document.getElementsByTagName("interface"):
1539
# Add property tags
1540
862
for tag in (make_tag(document, name, prop)
1541
863
for name, prop
1542
in self._get_all_dbus_things("property")
864
in self._get_all_dbus_properties()
1543
865
if prop._dbus_interface
1544
866
== if_tag.getAttribute("name")):
1545
867
if_tag.appendChild(tag)
1546
# Add annotation tags for properties
1547
for tag in if_tag.getElementsByTagName("property"):
1548
annots = dict()
1549
for name, prop in self._get_all_dbus_things(
1550
"property"):
1551
if (name == tag.getAttribute("name")
1552
and prop._dbus_interface
1553
== if_tag.getAttribute("name")):
1554
annots.update(getattr(
1555
prop, "_dbus_annotations", {}))
1556
for name, value in annots.items():
1557
ann_tag = document.createElement(
1558
"annotation")
1559
ann_tag.setAttribute("name", name)
1560
ann_tag.setAttribute("value", value)
1561
tag.appendChild(ann_tag)
1562
868
# Add the names to the return values for the
1563
869
# "org.freedesktop.DBus.Properties" methods
1564
870
if (if_tag.getAttribute("name")
1578
884
document.unlink()
1579
885
except (AttributeError, xml.dom.DOMException,
1580
886
xml.parsers.expat.ExpatError) as error:
1581
log.error("Failed to override Introspection method",
1582
exc_info=error)
1583
return xmlstring
1584
1585
1586
try:
1587
dbus.OBJECT_MANAGER_IFACE
1588
except AttributeError:
1589
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1590
1591
1592
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1593
"""A D-Bus object with an ObjectManager.
1594
1595
Classes inheriting from this exposes the standard
1596
GetManagedObjects call and the InterfacesAdded and
1597
InterfacesRemoved signals on the standard
1598
"org.freedesktop.DBus.ObjectManager" interface.
1599
1600
Note: No signals are sent automatically; they must be sent
1601
manually.
1602
"""
1603
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1604
out_signature="a{oa{sa{sv}}}")
1605
def GetManagedObjects(self):
1606
"""This function must be overridden"""
1607
raise NotImplementedError()
1608
1609
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1610
signature="oa{sa{sv}}")
1611
def InterfacesAdded(self, object_path, interfaces_and_properties):
1612
pass
1613
1614
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1615
def InterfacesRemoved(self, object_path, interfaces):
1616
pass
1617
1618
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1619
out_signature="s",
1620
path_keyword="object_path",
1621
connection_keyword="connection")
1622
def Introspect(self, object_path, connection):
1623
"""Overloading of standard D-Bus method.
1624
1625
Override return argument name of GetManagedObjects to be
1626
"objpath_interfaces_and_properties"
1627
"""
1628
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1629
object_path,
1630
connection)
1631
try:
1632
document = xml.dom.minidom.parseString(xmlstring)
1633
1634
for if_tag in document.getElementsByTagName("interface"):
1635
# Fix argument name for the GetManagedObjects method
1636
if (if_tag.getAttribute("name")
1637
== dbus.OBJECT_MANAGER_IFACE):
1638
for cn in if_tag.getElementsByTagName("method"):
1639
if (cn.getAttribute("name")
1640
== "GetManagedObjects"):
1641
for arg in cn.getElementsByTagName("arg"):
1642
if (arg.getAttribute("direction")
1643
== "out"):
1644
arg.setAttribute(
1645
"name",
1646
"objpath_interfaces"
1647
"_and_properties")
1648
xmlstring = document.toxml("utf-8")
1649
document.unlink()
1650
except (AttributeError, xml.dom.DOMException,
1651
xml.parsers.expat.ExpatError) as error:
1652
log.error("Failed to override Introspection method",
1653
exc_info=error)
1654
return xmlstring
1655
1656
1657
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):
1658
893
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1659
894
if dt is None:
1660
return dbus.String("", variant_level=variant_level)
1661
return dbus.String(dt.isoformat(), variant_level=variant_level)
1662
1663
1664
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1665
"""A class decorator; applied to a subclass of
1666
dbus.service.Object, it will add alternate D-Bus attributes with
1667
interface names according to the "alt_interface_names" mapping.
1668
Usage:
1669
1670
@alternate_dbus_interfaces({"org.example.Interface":
1671
"net.example.AlternateInterface"})
1672
class SampleDBusObject(dbus.service.Object):
1673
@dbus.service.method("org.example.Interface")
1674
def SampleDBusMethod():
1675
pass
1676
1677
The above "SampleDBusMethod" on "SampleDBusObject" will be
1678
reachable via two interfaces: "org.example.Interface" and
1679
"net.example.AlternateInterface", the latter of which will have
1680
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1681
"true", unless "deprecate" is passed with a False value.
1682
1683
This works for methods and signals, and also for D-Bus properties
1684
(from DBusObjectWithProperties) and interfaces (from the
1685
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.
1686
904
"""
1687
1688
def wrapper(cls):
1689
for orig_interface_name, alt_interface_name in (
1690
alt_interface_names.items()):
1691
attr = {}
1692
interface_names = set()
1693
# Go though all attributes of the class
1694
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):
1695
912
# Ignore non-D-Bus attributes, and D-Bus attributes
1696
913
# with the wrong interface name
1697
914
if (not hasattr(attribute, "_dbus_interface")
1698
or not attribute._dbus_interface.startswith(
1699
orig_interface_name)):
915
or not attribute._dbus_interface
916
.startswith("se.recompile.Mandos")):
1700
917
continue
1701
918
# Create an alternate D-Bus interface name based on
1702
919
# the current name
1703
alt_interface = attribute._dbus_interface.replace(
1704
orig_interface_name, alt_interface_name)
1705
interface_names.add(alt_interface)
920
alt_interface = (attribute._dbus_interface
921
.replace("se.recompile.Mandos",
922
"se.bsnet.fukt.Mandos"))
1706
923
# Is this a D-Bus signal?
1707
924
if getattr(attribute, "_dbus_is_signal", False):
1708
# Extract the original non-method undecorated
1709
# function by black magic
1710
if sys.version_info.major == 2:
1711
nonmethod_func = (dict(
925
# Extract the original non-method function by
926
# black magic
927
nonmethod_func = (dict(
1712
928
zip(attribute.func_code.co_freevars,
1713
attribute.__closure__))
1714
["func"].cell_contents)
1715
else:
1716
nonmethod_func = (dict(
1717
zip(attribute.__code__.co_freevars,
1718
attribute.__closure__))
1719
["func"].cell_contents)
929
attribute.__closure__))["func"]
930
.cell_contents)
1720
931
# Create a new, but exactly alike, function
1721
932
# object, and decorate it to be a new D-Bus signal
1722
933
# with the alternate D-Bus interface name
1723
new_function = copy_function(nonmethod_func)
1724
new_function = (dbus.service.signal(
1725
alt_interface,
1726
attribute._dbus_signature)(new_function))
1727
# Copy annotations, if any
1728
try:
1729
new_function._dbus_annotations = dict(
1730
attribute._dbus_annotations)
1731
except AttributeError:
1732
pass
1733
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)))
1734
943
# Define a creator of a function to call both the
1735
# original and alternate functions, so both the
1736
# original and alternate signals gets sent when
1737
# the function is called
944
# old and new functions, so both the old and new
945
# signals gets sent when the function is called
1738
946
def fixscope(func1, func2):
1739
947
"""This function is a scope container to pass
1740
948
func1 and func2 to the "call_both" function
1741
949
outside of its arguments"""
1742
1743
@functools.wraps(func2)
1744
950
def call_both(*args, **kwargs):
1745
951
"""This function will emit two D-Bus
1746
952
signals by calling func1 and func2"""
1747
953
func1(*args, **kwargs)
1748
954
func2(*args, **kwargs)
1749
# Make wrapper function look like a D-Bus
1750
# signal
1751
for name, attr in inspect.getmembers(func2):
1752
if name.startswith("_dbus_"):
1753
setattr(call_both, name, attr)
1754
1755
955
return call_both
1756
956
# Create the "call_both" function and add it to
1757
957
# the class
1758
attr[attrname] = fixscope(attribute, new_function)
958
attr[attrname] = fixscope(attribute,
959
new_function)
1759
960
# Is this a D-Bus method?
1760
961
elif getattr(attribute, "_dbus_is_method", False):
1761
962
# Create a new, but exactly alike, function
1762
963
# object. Decorate it to be a new D-Bus method
1763
964
# with the alternate D-Bus interface name. Add it
1764
965
# to the class.
1765
attr[attrname] = (
1766
dbus.service.method(
1767
alt_interface,
1768
attribute._dbus_in_signature,
1769
attribute._dbus_out_signature)
1770
(copy_function(attribute)))
1771
# Copy annotations, if any
1772
try:
1773
attr[attrname]._dbus_annotations = dict(
1774
attribute._dbus_annotations)
1775
except AttributeError:
1776
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)))
1777
976
# Is this a D-Bus property?
1778
977
elif getattr(attribute, "_dbus_is_property", False):
1779
978
# Create a new, but exactly alike, function
1780
979
# object, and decorate it to be a new D-Bus
1781
980
# property with the alternate D-Bus interface
1782
981
# name. Add it to the class.
1783
attr[attrname] = (dbus_service_property(
1784
alt_interface, attribute._dbus_signature,
1785
attribute._dbus_access,
1786
attribute._dbus_get_args_options
1787
["byte_arrays"])
1788
(copy_function(attribute)))
1789
# Copy annotations, if any
1790
try:
1791
attr[attrname]._dbus_annotations = dict(
1792
attribute._dbus_annotations)
1793
except AttributeError:
1794
pass
1795
# Is this a D-Bus interface?
1796
elif getattr(attribute, "_dbus_is_interface", False):
1797
# Create a new, but exactly alike, function
1798
# object. Decorate it to be a new D-Bus interface
1799
# with the alternate D-Bus interface name. Add it
1800
# to the class.
1801
attr[attrname] = (
1802
dbus_interface_annotations(alt_interface)
1803
(copy_function(attribute)))
1804
if deprecate:
1805
# Deprecate all alternate interfaces
1806
iname = "_AlternateDBusNames_interface_annotation{}"
1807
for interface_name in interface_names:
1808
1809
@dbus_interface_annotations(interface_name)
1810
def func(self):
1811
return {"org.freedesktop.DBus.Deprecated":
1812
"true"}
1813
# Find an unused name
1814
for aname in (iname.format(i)
1815
for i in itertools.count()):
1816
if aname not in attr:
1817
attr[aname] = func
1818
break
1819
if interface_names:
1820
# Replace the class with a new subclass of it with
1821
# methods, signals, etc. as created above.
1822
if sys.version_info.major == 2:
1823
cls = type(b"{}Alternate".format(cls.__name__),
1824
(cls, ), attr)
1825
else:
1826
cls = type("{}Alternate".format(cls.__name__),
1827
(cls, ), attr)
1828
return cls
1829
1830
return wrapper
1831
1832
1833
@alternate_dbus_interfaces({"se.recompile.Mandos":
1834
"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
1835
998
class ClientDBus(Client, DBusObjectWithProperties):
1836
999
"""A Client class using D-Bus
1837
1000
1838
1001
Attributes:
1839
1002
dbus_object_path: dbus.ObjectPath
1840
1003
bus: dbus.SystemBus()
1841
1004
"""
1842
1005
1843
1006
runtime_expansions = (Client.runtime_expansions
1844
+ ("dbus_object_path", ))
1845
1846
_interface = "se.recompile.Mandos.Client"
1847
1007
+ ("dbus_object_path",))
1008
1848
1009
# dbus.service.Object doesn't use super(), so we can't either.
1849
1850
def __init__(self, bus=None, *args, **kwargs):
1010
1011
def __init__(self, bus = None, *args, **kwargs):
1851
1012
self.bus = bus
1852
1013
Client.__init__(self, *args, **kwargs)
1014
1015
self._approvals_pending = 0
1853
1016
# Only now, when this client is initialized, can it show up on
1854
1017
# the D-Bus
1855
client_object_name = str(self.name).translate(
1018
client_object_name = unicode(self.name).translate(
1856
1019
{ord("."): ord("_"),
1857
1020
ord("-"): ord("_")})
1858
self.dbus_object_path = dbus.ObjectPath(
1859
"/clients/" + client_object_name)
1021
self.dbus_object_path = (dbus.ObjectPath
1022
("/clients/" + client_object_name))
1860
1023
DBusObjectWithProperties.__init__(self, self.bus,
1861
1024
self.dbus_object_path)
1862
1863
def notifychangeproperty(transform_func, dbus_name,
1864
type_func=lambda x: x,
1865
variant_level=1,
1866
invalidate_only=False,
1867
_interface=_interface):
1025
1026
def notifychangeproperty(transform_func,
1027
dbus_name, type_func=lambda x: x,
1028
variant_level=1):
1868
1029
""" Modify a variable so that it's a property which announces
1869
1030
its changes to DBus.
1870
1031
1871
1032
transform_fun: Function that takes a value and a variant_level
1872
1033
and transforms it to a D-Bus type.
1873
1034
dbus_name: D-Bus name of the variable
1875
1036
to the D-Bus. Default: no transform
1876
1037
variant_level: D-Bus variant level. Default: 1
1877
1038
"""
1878
attrname = "_{}".format(dbus_name)
1879
1039
attrname = "_{0}".format(dbus_name)
1880
1040
def setter(self, value):
1881
1041
if hasattr(self, "dbus_object_path"):
1882
1042
if (not hasattr(self, attrname) or
1883
1043
type_func(getattr(self, attrname, None))
1884
1044
!= type_func(value)):
1885
if invalidate_only:
1886
self.PropertiesChanged(
1887
_interface, dbus.Dictionary(),
1888
dbus.Array((dbus_name, )))
1889
else:
1890
dbus_value = transform_func(
1891
type_func(value),
1892
variant_level=variant_level)
1893
self.PropertyChanged(dbus.String(dbus_name),
1894
dbus_value)
1895
self.PropertiesChanged(
1896
_interface,
1897
dbus.Dictionary({dbus.String(dbus_name):
1898
dbus_value}),
1899
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)
1900
1050
setattr(self, attrname, value)
1901
1051
1902
1052
return property(lambda self: getattr(self, attrname), setter)
1903
1053
1054
1904
1055
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1905
1056
approvals_pending = notifychangeproperty(dbus.Boolean,
1906
1057
"ApprovalPending",
1907
type_func=bool)
1058
type_func = bool)
1908
1059
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1909
1060
last_enabled = notifychangeproperty(datetime_to_dbus,
1910
1061
"LastEnabled")
1911
checker = notifychangeproperty(
1912
dbus.Boolean, "CheckerRunning",
1913
type_func=lambda checker: checker is not None)
1062
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1063
type_func = lambda checker:
1064
checker is not None)
1914
1065
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1915
1066
"LastCheckedOK")
1916
last_checker_status = notifychangeproperty(dbus.Int16,
1917
"LastCheckerStatus")
1918
1067
last_approval_request = notifychangeproperty(
1919
1068
datetime_to_dbus, "LastApprovalRequest")
1920
1069
approved_by_default = notifychangeproperty(dbus.Boolean,
1921
1070
"ApprovedByDefault")
1922
approval_delay = notifychangeproperty(
1923
dbus.UInt64, "ApprovalDelay",
1924
type_func=lambda td: td.total_seconds() * 1000)
1071
approval_delay = notifychangeproperty(dbus.UInt16,
1072
"ApprovalDelay",
1073
type_func =
1074
_timedelta_to_milliseconds)
1925
1075
approval_duration = notifychangeproperty(
1926
dbus.UInt64, "ApprovalDuration",
1927
type_func=lambda td: td.total_seconds() * 1000)
1076
dbus.UInt16, "ApprovalDuration",
1077
type_func = _timedelta_to_milliseconds)
1928
1078
host = notifychangeproperty(dbus.String, "Host")
1929
timeout = notifychangeproperty(
1930
dbus.UInt64, "Timeout",
1931
type_func=lambda td: td.total_seconds() * 1000)
1079
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1080
type_func =
1081
_timedelta_to_milliseconds)
1932
1082
extended_timeout = notifychangeproperty(
1933
dbus.UInt64, "ExtendedTimeout",
1934
type_func=lambda td: td.total_seconds() * 1000)
1935
interval = notifychangeproperty(
1936
dbus.UInt64, "Interval",
1937
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)
1938
1089
checker_command = notifychangeproperty(dbus.String, "Checker")
1939
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1940
invalidate_only=True)
1941
1090
1942
1091
del notifychangeproperty
1943
1092
1944
1093
def __del__(self, *args, **kwargs):
1945
1094
try:
1946
1095
self.remove_from_connection()
1949
1098
if hasattr(DBusObjectWithProperties, "__del__"):
1950
1099
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1951
1100
Client.__del__(self, *args, **kwargs)
1952
1953
def checker_callback(self, source, condition,
1954
connection, command, *args, **kwargs):
1955
ret = Client.checker_callback(self, source, condition,
1956
connection, command, *args,
1957
**kwargs)
1958
exitstatus = self.last_checker_status
1959
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)
1960
1108
# Emit D-Bus signal
1961
1109
self.CheckerCompleted(dbus.Int16(exitstatus),
1962
# This is specific to GNU libC
1963
dbus.Int64(exitstatus << 8),
1110
dbus.Int64(condition),
1964
1111
dbus.String(command))
1965
1112
else:
1966
1113
# Emit D-Bus signal
1967
1114
self.CheckerCompleted(dbus.Int16(-1),
1968
dbus.Int64(
1969
# This is specific to GNU libC
1970
(exitstatus << 8)
1971
| self.last_checker_signal),
1115
dbus.Int64(condition),
1972
1116
dbus.String(command))
1973
return ret
1974
1117
1118
return Client.checker_callback(self, pid, condition, command,
1119
*args, **kwargs)
1120
1975
1121
def start_checker(self, *args, **kwargs):
1976
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
1977
1127
r = Client.start_checker(self, *args, **kwargs)
1978
1128
# Only if new checker process was started
1979
1129
if (self.checker is not None
1981
1131
# Emit D-Bus signal
1982
1132
self.CheckerStarted(self.current_checker_command)
1983
1133
return r
1984
1134
1985
1135
def _reset_approved(self):
1986
self.approved = None
1136
self._approved = None
1987
1137
return False
1988
1138
1989
1139
def approve(self, value=True):
1990
self.approved = value
1991
GLib.timeout_add(int(self.approval_duration.total_seconds()
1992
* 1000), self._reset_approved)
1993
1140
self.send_changedstate()
1994
1995
# D-Bus methods, signals & properties
1996
1997
# Interfaces
1998
1999
# Signals
2000
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
2001
1152
# CheckerCompleted - signal
2002
1153
@dbus.service.signal(_interface, signature="nxs")
2003
1154
def CheckerCompleted(self, exitcode, waitstatus, command):
2004
1155
"D-Bus signal"
2005
1156
pass
2006
1157
2007
1158
# CheckerStarted - signal
2008
1159
@dbus.service.signal(_interface, signature="s")
2009
1160
def CheckerStarted(self, command):
2010
1161
"D-Bus signal"
2011
1162
pass
2012
1163
2013
1164
# PropertyChanged - signal
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2015
1165
@dbus.service.signal(_interface, signature="sv")
2016
1166
def PropertyChanged(self, property, value):
2017
1167
"D-Bus signal"
2018
1168
pass
2019
1169
2020
1170
# GotSecret - signal
2021
1171
@dbus.service.signal(_interface)
2022
1172
def GotSecret(self):
2025
1175
server to mandos-client
2026
1176
"""
2027
1177
pass
2028
1178
2029
1179
# Rejected - signal
2030
1180
@dbus.service.signal(_interface, signature="s")
2031
1181
def Rejected(self, reason):
2032
1182
"D-Bus signal"
2033
1183
pass
2034
1184
2035
1185
# NeedApproval - signal
2036
1186
@dbus.service.signal(_interface, signature="tb")
2037
1187
def NeedApproval(self, timeout, default):
2038
1188
"D-Bus signal"
2039
1189
return self.need_approval()
2040
2041
# Methods
2042
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
2043
1201
# Approve - method
2044
1202
@dbus.service.method(_interface, in_signature="b")
2045
1203
def Approve(self, value):
2046
1204
self.approve(value)
2047
1205
2048
1206
# CheckedOK - method
2049
1207
@dbus.service.method(_interface)
2050
1208
def CheckedOK(self):
2051
1209
self.checked_ok()
2052
1210
2053
1211
# Enable - method
2054
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2055
1212
@dbus.service.method(_interface)
2056
1213
def Enable(self):
2057
1214
"D-Bus method"
2058
1215
self.enable()
2059
1216
2060
1217
# StartChecker - method
2061
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2062
1218
@dbus.service.method(_interface)
2063
1219
def StartChecker(self):
2064
1220
"D-Bus method"
2065
1221
self.start_checker()
2066
1222
2067
1223
# Disable - method
2068
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2069
1224
@dbus.service.method(_interface)
2070
1225
def Disable(self):
2071
1226
"D-Bus method"
2072
1227
self.disable()
2073
1228
2074
1229
# StopChecker - method
2075
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2076
1230
@dbus.service.method(_interface)
2077
1231
def StopChecker(self):
2078
1232
self.stop_checker()
2079
2080
# Properties
2081
1233
1234
## Properties
1235
2082
1236
# ApprovalPending - property
2083
1237
@dbus_service_property(_interface, signature="b", access="read")
2084
1238
def ApprovalPending_dbus_property(self):
2085
1239
return dbus.Boolean(bool(self.approvals_pending))
2086
1240
2087
1241
# ApprovedByDefault - property
2088
@dbus_service_property(_interface,
2089
signature="b",
1242
@dbus_service_property(_interface, signature="b",
2090
1243
access="readwrite")
2091
1244
def ApprovedByDefault_dbus_property(self, value=None):
2092
1245
if value is None: # get
2093
1246
return dbus.Boolean(self.approved_by_default)
2094
1247
self.approved_by_default = bool(value)
2095
1248
2096
1249
# ApprovalDelay - property
2097
@dbus_service_property(_interface,
2098
signature="t",
1250
@dbus_service_property(_interface, signature="t",
2099
1251
access="readwrite")
2100
1252
def ApprovalDelay_dbus_property(self, value=None):
2101
1253
if value is None: # get
2102
return dbus.UInt64(self.approval_delay.total_seconds()
2103
* 1000)
1254
return dbus.UInt64(self.approval_delay_milliseconds())
2104
1255
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2105
1256
2106
1257
# ApprovalDuration - property
2107
@dbus_service_property(_interface,
2108
signature="t",
1258
@dbus_service_property(_interface, signature="t",
2109
1259
access="readwrite")
2110
1260
def ApprovalDuration_dbus_property(self, value=None):
2111
1261
if value is None: # get
2112
return dbus.UInt64(self.approval_duration.total_seconds()
2113
* 1000)
1262
return dbus.UInt64(_timedelta_to_milliseconds(
1263
self.approval_duration))
2114
1264
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2115
1265
2116
1266
# Name - property
2117
@dbus_annotations(
2118
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2119
1267
@dbus_service_property(_interface, signature="s", access="read")
2120
1268
def Name_dbus_property(self):
2121
1269
return dbus.String(self.name)
2122
2123
# KeyID - property
2124
@dbus_annotations(
2125
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2126
@dbus_service_property(_interface, signature="s", access="read")
2127
def KeyID_dbus_property(self):
2128
return dbus.String(self.key_id)
2129
1270
2130
1271
# Fingerprint - property
2131
@dbus_annotations(
2132
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2133
1272
@dbus_service_property(_interface, signature="s", access="read")
2134
1273
def Fingerprint_dbus_property(self):
2135
1274
return dbus.String(self.fingerprint)
2136
1275
2137
1276
# Host - property
2138
@dbus_service_property(_interface,
2139
signature="s",
1277
@dbus_service_property(_interface, signature="s",
2140
1278
access="readwrite")
2141
1279
def Host_dbus_property(self, value=None):
2142
1280
if value is None: # get
2143
1281
return dbus.String(self.host)
2144
self.host = str(value)
2145
1282
self.host = value
1283
2146
1284
# Created - property
2147
@dbus_annotations(
2148
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2149
1285
@dbus_service_property(_interface, signature="s", access="read")
2150
1286
def Created_dbus_property(self):
2151
1287
return datetime_to_dbus(self.created)
2152
1288
2153
1289
# LastEnabled - property
2154
1290
@dbus_service_property(_interface, signature="s", access="read")
2155
1291
def LastEnabled_dbus_property(self):
2156
1292
return datetime_to_dbus(self.last_enabled)
2157
1293
2158
1294
# Enabled - property
2159
@dbus_service_property(_interface,
2160
signature="b",
1295
@dbus_service_property(_interface, signature="b",
2161
1296
access="readwrite")
2162
1297
def Enabled_dbus_property(self, value=None):
2163
1298
if value is None: # get
2166
1301
self.enable()
2167
1302
else:
2168
1303
self.disable()
2169
1304
2170
1305
# LastCheckedOK - property
2171
@dbus_service_property(_interface,
2172
signature="s",
1306
@dbus_service_property(_interface, signature="s",
2173
1307
access="readwrite")
2174
1308
def LastCheckedOK_dbus_property(self, value=None):
2175
1309
if value is not None:
2176
1310
self.checked_ok()
2177
1311
return
2178
1312
return datetime_to_dbus(self.last_checked_ok)
2179
2180
# LastCheckerStatus - property
2181
@dbus_service_property(_interface, signature="n", access="read")
2182
def LastCheckerStatus_dbus_property(self):
2183
return dbus.Int16(self.last_checker_status)
2184
1313
2185
1314
# Expires - property
2186
1315
@dbus_service_property(_interface, signature="s", access="read")
2187
1316
def Expires_dbus_property(self):
2188
1317
return datetime_to_dbus(self.expires)
2189
1318
2190
1319
# LastApprovalRequest - property
2191
1320
@dbus_service_property(_interface, signature="s", access="read")
2192
1321
def LastApprovalRequest_dbus_property(self):
2193
1322
return datetime_to_dbus(self.last_approval_request)
2194
1323
2195
1324
# Timeout - property
2196
@dbus_service_property(_interface,
2197
signature="t",
1325
@dbus_service_property(_interface, signature="t",
2198
1326
access="readwrite")
2199
1327
def Timeout_dbus_property(self, value=None):
2200
1328
if value is None: # get
2201
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2202
old_timeout = self.timeout
1329
return dbus.UInt64(self.timeout_milliseconds())
2203
1330
self.timeout = datetime.timedelta(0, 0, 0, value)
2204
# Reschedule disabling
2205
if self.enabled:
2206
now = datetime.datetime.utcnow()
2207
self.expires += self.timeout - old_timeout
2208
if self.expires <= now:
2209
# The timeout has passed
2210
self.disable()
2211
else:
2212
if (getattr(self, "disable_initiator_tag", None)
2213
is None):
2214
return
2215
GLib.source_remove(self.disable_initiator_tag)
2216
self.disable_initiator_tag = GLib.timeout_add(
2217
int((self.expires - now).total_seconds() * 1000),
2218
self.disable)
2219
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
2220
1352
# ExtendedTimeout - property
2221
@dbus_service_property(_interface,
2222
signature="t",
1353
@dbus_service_property(_interface, signature="t",
2223
1354
access="readwrite")
2224
1355
def ExtendedTimeout_dbus_property(self, value=None):
2225
1356
if value is None: # get
2226
return dbus.UInt64(self.extended_timeout.total_seconds()
2227
* 1000)
1357
return dbus.UInt64(self.extended_timeout_milliseconds())
2228
1358
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2229
1359
2230
1360
# Interval - property
2231
@dbus_service_property(_interface,
2232
signature="t",
1361
@dbus_service_property(_interface, signature="t",
2233
1362
access="readwrite")
2234
1363
def Interval_dbus_property(self, value=None):
2235
1364
if value is None: # get
2236
return dbus.UInt64(self.interval.total_seconds() * 1000)
1365
return dbus.UInt64(self.interval_milliseconds())
2237
1366
self.interval = datetime.timedelta(0, 0, 0, value)
2238
1367
if getattr(self, "checker_initiator_tag", None) is None:
2239
1368
return
2240
1369
if self.enabled:
2241
1370
# Reschedule checker run
2242
GLib.source_remove(self.checker_initiator_tag)
2243
self.checker_initiator_tag = GLib.timeout_add(
2244
value, self.start_checker)
2245
self.start_checker() # Start one now, too
2246
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
2247
1376
# Checker - property
2248
@dbus_service_property(_interface,
2249
signature="s",
1377
@dbus_service_property(_interface, signature="s",
2250
1378
access="readwrite")
2251
1379
def Checker_dbus_property(self, value=None):
2252
1380
if value is None: # get
2253
1381
return dbus.String(self.checker_command)
2254
self.checker_command = str(value)
2255
1382
self.checker_command = value
1383
2256
1384
# CheckerRunning - property
2257
@dbus_service_property(_interface,
2258
signature="b",
1385
@dbus_service_property(_interface, signature="b",
2259
1386
access="readwrite")
2260
1387
def CheckerRunning_dbus_property(self, value=None):
2261
1388
if value is None: # get
2264
1391
self.start_checker()
2265
1392
else:
2266
1393
self.stop_checker()
2267
1394
2268
1395
# ObjectPath - property
2269
@dbus_annotations(
2270
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2271
"org.freedesktop.DBus.Deprecated": "true"})
2272
1396
@dbus_service_property(_interface, signature="o", access="read")
2273
1397
def ObjectPath_dbus_property(self):
2274
return self.dbus_object_path # is already a dbus.ObjectPath
2275
1398
return self.dbus_object_path # is already a dbus.ObjectPath
1399
2276
1400
# Secret = property
2277
@dbus_annotations(
2278
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2279
"invalidates"})
2280
@dbus_service_property(_interface,
2281
signature="ay",
2282
access="write",
2283
byte_arrays=True)
1401
@dbus_service_property(_interface, signature="ay",
1402
access="write", byte_arrays=True)
2284
1403
def Secret_dbus_property(self, value):
2285
self.secret = bytes(value)
2286
1404
self.secret = str(value)
1405
2287
1406
del _interface
2288
1407
2289
1408
2290
class ProxyClient:
2291
def __init__(self, child_pipe, key_id, fpr, address):
1409
class ProxyClient(object):
1410
def __init__(self, child_pipe, fpr, address):
2292
1411
self._pipe = child_pipe
2293
self._pipe.send(("init", key_id, fpr, address))
1412
self._pipe.send(('init', fpr, address))
2294
1413
if not self._pipe.recv():
2295
raise KeyError(key_id or fpr)
2296
1414
raise KeyError()
1415
2297
1416
def __getattribute__(self, name):
2298
if name == "_pipe":
1417
if(name == '_pipe'):
2299
1418
return super(ProxyClient, self).__getattribute__(name)
2300
self._pipe.send(("getattr", name))
1419
self._pipe.send(('getattr', name))
2301
1420
data = self._pipe.recv()
2302
if data[0] == "data":
1421
if data[0] == 'data':
2303
1422
return data[1]
2304
if data[0] == "function":
2305
1423
if data[0] == 'function':
2306
1424
def func(*args, **kwargs):
2307
self._pipe.send(("funcall", name, args, kwargs))
1425
self._pipe.send(('funcall', name, args, kwargs))
2308
1426
return self._pipe.recv()[1]
2309
2310
1427
return func
2311
1428
2312
1429
def __setattr__(self, name, value):
2313
if name == "_pipe":
1430
if(name == '_pipe'):
2314
1431
return super(ProxyClient, self).__setattr__(name, value)
2315
self._pipe.send(("setattr", name, value))
1432
self._pipe.send(('setattr', name, value))
1433
1434
1435
class ClientDBusTransitional(ClientDBus):
1436
__metaclass__ = AlternateDBusNamesMetaclass
2316
1437
2317
1438
2318
1439
class ClientHandler(socketserver.BaseRequestHandler, object):
2319
1440
"""A class to handle client connections.
2320
1441
2321
1442
Instantiated once for each connection to handle it.
2322
1443
Note: This will run in its own forked process."""
2323
1444
2324
1445
def handle(self):
2325
1446
with contextlib.closing(self.server.child_pipe) as child_pipe:
2326
log.info("TCP connection from: %s",
2327
str(self.client_address))
2328
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2329
2330
session = gnutls.ClientSession(self.request)
2331
2332
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2333
# "+AES-256-CBC", "+SHA1",
2334
# "+COMP-NULL", "+CTYPE-OPENPGP",
2335
# "+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"))
2336
1466
# Use a fallback default, since this MUST be set.
2337
1467
priority = self.server.gnutls_priority
2338
1468
if priority is None:
2339
1469
priority = "NORMAL"
2340
gnutls.priority_set_direct(session,
2341
priority.encode("utf-8"), None)
2342
1470
(gnutls.library.functions
1471
.gnutls_priority_set_direct(session._c_object,
1472
priority, None))
1473
2343
1474
# Start communication using the Mandos protocol
2344
1475
# Get protocol number
2345
1476
line = self.request.makefile().readline()
2346
log.debug("Protocol version: %r", line)
1477
logger.debug("Protocol version: %r", line)
2347
1478
try:
2348
1479
if int(line.strip().split()[0]) > 1:
2349
raise RuntimeError(line)
1480
raise RuntimeError
2350
1481
except (ValueError, IndexError, RuntimeError) as error:
2351
log.error("Unknown protocol version: %s", error)
1482
logger.error("Unknown protocol version: %s", error)
2352
1483
return
2353
1484
2354
1485
# Start GnuTLS connection
2355
1486
try:
2356
1487
session.handshake()
2357
except gnutls.Error as error:
2358
log.warning("Handshake failed: %s", error)
1488
except gnutls.errors.GNUTLSError as error:
1489
logger.warning("Handshake failed: %s", error)
2359
1490
# Do not run session.bye() here: the session is not
2360
1491
# established. Just abandon the request.
2361
1492
return
2362
log.debug("Handshake succeeded")
2363
1493
logger.debug("Handshake succeeded")
1494
2364
1495
approval_required = False
2365
1496
try:
2366
if gnutls.has_rawpk:
2367
fpr = b""
2368
try:
2369
key_id = self.key_id(
2370
self.peer_certificate(session))
2371
except (TypeError, gnutls.Error) as error:
2372
log.warning("Bad certificate: %s", error)
2373
return
2374
log.debug("Key ID: %s",
2375
key_id.decode("utf-8",
2376
errors="replace"))
2377
2378
else:
2379
key_id = b""
2380
try:
2381
fpr = self.fingerprint(
2382
self.peer_certificate(session))
2383
except (TypeError, gnutls.Error) as error:
2384
log.warning("Bad certificate: %s", error)
2385
return
2386
log.debug("Fingerprint: %s", fpr)
2387
2388
try:
2389
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,
2390
1511
self.client_address)
2391
1512
except KeyError:
2392
1513
return
2393
1514
2394
1515
if client.approval_delay:
2395
1516
delay = client.approval_delay
2396
1517
client.approvals_pending += 1
2397
1518
approval_required = True
2398
1519
2399
1520
while True:
2400
1521
if not client.enabled:
2401
log.info("Client %s is disabled", client.name)
1522
logger.info("Client %s is disabled",
1523
client.name)
2402
1524
if self.server.use_dbus:
2403
1525
# Emit D-Bus signal
2404
1526
client.Rejected("Disabled")
2405
1527
return
2406
2407
if client.approved or not client.approval_delay:
2408
# 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
2409
1531
break
2410
elif client.approved is None:
2411
log.info("Client %s needs approval",
2412
client.name)
1532
elif client._approved is None:
1533
logger.info("Client %s needs approval",
1534
client.name)
2413
1535
if self.server.use_dbus:
2414
1536
# Emit D-Bus signal
2415
1537
client.NeedApproval(
2416
client.approval_delay.total_seconds()
2417
* 1000, client.approved_by_default)
1538
client.approval_delay_milliseconds(),
1539
client.approved_by_default)
2418
1540
else:
2419
log.warning("Client %s was not approved",
2420
client.name)
1541
logger.warning("Client %s was not approved",
1542
client.name)
2421
1543
if self.server.use_dbus:
2422
1544
# Emit D-Bus signal
2423
1545
client.Rejected("Denied")
2424
1546
return
2425
2426
# wait until timeout or approved
1547
1548
#wait until timeout or approved
2427
1549
time = datetime.datetime.now()
2428
1550
client.changedstate.acquire()
2429
client.changedstate.wait(delay.total_seconds())
1551
(client.changedstate.wait
1552
(float(client._timedelta_to_milliseconds(delay)
1553
/ 1000)))
2430
1554
client.changedstate.release()
2431
1555
time2 = datetime.datetime.now()
2432
1556
if (time2 - time) >= delay:
2433
1557
if not client.approved_by_default:
2434
log.warning("Client %s timed out while"
2435
" waiting for approval",
2436
client.name)
1558
logger.warning("Client %s timed out while"
1559
" waiting for approval",
1560
client.name)
2437
1561
if self.server.use_dbus:
2438
1562
# Emit D-Bus signal
2439
1563
client.Rejected("Approval timed out")
2442
1566
break
2443
1567
else:
2444
1568
delay -= time2 - time
2445
2446
try:
2447
session.send(client.secret)
2448
except gnutls.Error as error:
2449
log.warning("gnutls send failed", exc_info=error)
2450
return
2451
2452
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)
2453
1583
# bump the timeout using extended_timeout
2454
client.bump_timeout(client.extended_timeout)
1584
client.checked_ok(client.extended_timeout)
2455
1585
if self.server.use_dbus:
2456
1586
# Emit D-Bus signal
2457
1587
client.GotSecret()
2458
1588
2459
1589
finally:
2460
1590
if approval_required:
2461
1591
client.approvals_pending -= 1
2462
1592
try:
2463
1593
session.bye()
2464
except gnutls.Error as error:
2465
log.warning("GnuTLS bye failed", exc_info=error)
2466
1594
except gnutls.errors.GNUTLSError as error:
1595
logger.warning("GnuTLS bye failed")
1596
2467
1597
@staticmethod
2468
1598
def peer_certificate(session):
2469
"Return the peer's certificate as a bytestring"
2470
try:
2471
cert_type = gnutls.certificate_type_get2(
2472
session, gnutls.CTYPE_PEERS)
2473
except AttributeError:
2474
cert_type = gnutls.certificate_type_get(session)
2475
if gnutls.has_rawpk:
2476
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2477
else:
2478
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2479
# If not a valid certificate type...
2480
if cert_type not in valid_cert_types:
2481
log.info("Cert type %r not in %r", cert_type,
2482
valid_cert_types)
2483
# ...return invalid data
2484
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
2485
1606
list_size = ctypes.c_uint(1)
2486
cert_list = (gnutls.certificate_get_peers
2487
(session, ctypes.byref(list_size)))
1607
cert_list = (gnutls.library.functions
1608
.gnutls_certificate_get_peers
1609
(session._c_object, ctypes.byref(list_size)))
2488
1610
if not bool(cert_list) and list_size.value != 0:
2489
raise gnutls.Error("error getting peer certificate")
1611
raise gnutls.errors.GNUTLSError("error getting peer"
1612
" certificate")
2490
1613
if list_size.value == 0:
2491
1614
return None
2492
1615
cert = cert_list[0]
2493
1616
return ctypes.string_at(cert.data, cert.size)
2494
2495
@staticmethod
2496
def key_id(certificate):
2497
"Convert a certificate bytestring to a hexdigit key ID"
2498
# New GnuTLS "datum" with the public key
2499
datum = gnutls.datum_t(
2500
ctypes.cast(ctypes.c_char_p(certificate),
2501
ctypes.POINTER(ctypes.c_ubyte)),
2502
ctypes.c_uint(len(certificate)))
2503
# XXX all these need to be created in the gnutls "module"
2504
# New empty GnuTLS certificate
2505
pubkey = gnutls.pubkey_t()
2506
gnutls.pubkey_init(ctypes.byref(pubkey))
2507
# Import the raw public key into the certificate
2508
gnutls.pubkey_import(pubkey,
2509
ctypes.byref(datum),
2510
gnutls.X509_FMT_DER)
2511
# New buffer for the key ID
2512
buf = ctypes.create_string_buffer(32)
2513
buf_len = ctypes.c_size_t(len(buf))
2514
# Get the key ID from the raw public key into the buffer
2515
gnutls.pubkey_get_key_id(
2516
pubkey,
2517
gnutls.KEYID_USE_SHA256,
2518
ctypes.cast(ctypes.byref(buf),
2519
ctypes.POINTER(ctypes.c_ubyte)),
2520
ctypes.byref(buf_len))
2521
# Deinit the certificate
2522
gnutls.pubkey_deinit(pubkey)
2523
2524
# Convert the buffer to a Python bytestring
2525
key_id = ctypes.string_at(buf, buf_len.value)
2526
# Convert the bytestring to hexadecimal notation
2527
hex_key_id = binascii.hexlify(key_id).upper()
2528
return hex_key_id
2529
1617
2530
1618
@staticmethod
2531
1619
def fingerprint(openpgp):
2532
1620
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2533
1621
# New GnuTLS "datum" with the OpenPGP public key
2534
datum = gnutls.datum_t(
2535
ctypes.cast(ctypes.c_char_p(openpgp),
2536
ctypes.POINTER(ctypes.c_ubyte)),
2537
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))))
2538
1627
# New empty GnuTLS certificate
2539
crt = gnutls.openpgp_crt_t()
2540
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)))
2541
1631
# Import the OpenPGP public key into the certificate
2542
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2543
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))
2544
1636
# Verify the self signature in the key
2545
1637
crtverify = ctypes.c_uint()
2546
gnutls.openpgp_crt_verify_self(crt, 0,
2547
ctypes.byref(crtverify))
1638
(gnutls.library.functions
1639
.gnutls_openpgp_crt_verify_self(crt, 0,
1640
ctypes.byref(crtverify)))
2548
1641
if crtverify.value != 0:
2549
gnutls.openpgp_crt_deinit(crt)
2550
raise gnutls.CertificateSecurityError(code
2551
=crtverify.value)
1642
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1643
raise (gnutls.errors.CertificateSecurityError
1644
("Verify failed"))
2552
1645
# New buffer for the fingerprint
2553
1646
buf = ctypes.create_string_buffer(20)
2554
1647
buf_len = ctypes.c_size_t()
2555
1648
# Get the fingerprint from the certificate into the buffer
2556
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2557
ctypes.byref(buf_len))
1649
(gnutls.library.functions
1650
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1651
ctypes.byref(buf_len)))
2558
1652
# Deinit the certificate
2559
gnutls.openpgp_crt_deinit(crt)
1653
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2560
1654
# Convert the buffer to a Python bytestring
2561
1655
fpr = ctypes.string_at(buf, buf_len.value)
2562
1656
# Convert the bytestring to hexadecimal notation
2564
1658
return hex_fpr
2565
1659
2566
1660
2567
class MultiprocessingMixIn:
1661
class MultiprocessingMixIn(object):
2568
1662
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2569
2570
1663
def sub_process_main(self, request, address):
2571
1664
try:
2572
1665
self.finish_request(request, address)
2573
except Exception:
1666
except:
2574
1667
self.handle_error(request, address)
2575
1668
self.close_request(request)
2576
1669
2577
1670
def process_request(self, request, address):
2578
1671
"""Start a new process to process the request."""
2579
proc = multiprocessing.Process(target=self.sub_process_main,
2580
args=(request, address))
1672
proc = multiprocessing.Process(target = self.sub_process_main,
1673
args = (request,
1674
address))
2581
1675
proc.start()
2582
1676
return proc
2583
1677
2584
1678
2585
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1679
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2586
1680
""" adds a pipe to the MixIn """
2587
2588
1681
def process_request(self, request, client_address):
2589
1682
"""Overrides and wraps the original process_request().
2590
1683
2591
1684
This function creates a new pipe in self.pipe
2592
1685
"""
2593
1686
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2594
1687
2595
1688
proc = MultiprocessingMixIn.process_request(self, request,
2596
1689
client_address)
2597
1690
self.child_pipe.close()
2598
1691
self.add_pipe(parent_pipe, proc)
2599
1692
2600
1693
def add_pipe(self, parent_pipe, proc):
2601
1694
"""Dummy function; override as necessary"""
2602
raise NotImplementedError()
1695
raise NotImplementedError
2603
1696
2604
1697
2605
1698
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2606
socketserver.TCPServer):
2607
"""IPv6-capable TCP server. Accepts None as address and/or port
2608
1699
socketserver.TCPServer, object):
1700
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1701
2609
1702
Attributes:
2610
1703
enabled: Boolean; whether this server is activated yet
2611
1704
interface: None or a network interface name (string)
2612
1705
use_ipv6: Boolean; to use IPv6 or not
2613
1706
"""
2614
2615
1707
def __init__(self, server_address, RequestHandlerClass,
2616
interface=None,
2617
use_ipv6=True,
2618
socketfd=None):
2619
"""If socketfd is set, use that file descriptor instead of
2620
creating a new one with socket.socket().
2621
"""
1708
interface=None, use_ipv6=True):
2622
1709
self.interface = interface
2623
1710
if use_ipv6:
2624
1711
self.address_family = socket.AF_INET6
2625
if socketfd is not None:
2626
# Save the file descriptor
2627
self.socketfd = socketfd
2628
# Save the original socket.socket() function
2629
self.socket_socket = socket.socket
2630
2631
# To implement --socket, we monkey patch socket.socket.
2632
#
2633
# (When socketserver.TCPServer is a new-style class, we
2634
# could make self.socket into a property instead of monkey
2635
# patching socket.socket.)
2636
#
2637
# Create a one-time-only replacement for socket.socket()
2638
@functools.wraps(socket.socket)
2639
def socket_wrapper(*args, **kwargs):
2640
# Restore original function so subsequent calls are
2641
# not affected.
2642
socket.socket = self.socket_socket
2643
del self.socket_socket
2644
# This time only, return a new socket object from the
2645
# saved file descriptor.
2646
return socket.fromfd(self.socketfd, *args, **kwargs)
2647
# Replace socket.socket() function with wrapper
2648
socket.socket = socket_wrapper
2649
# The socketserver.TCPServer.__init__ will call
2650
# socket.socket(), which might be our replacement,
2651
# socket_wrapper(), if socketfd was set.
2652
1712
socketserver.TCPServer.__init__(self, server_address,
2653
1713
RequestHandlerClass)
2654
2655
1714
def server_bind(self):
2656
1715
"""This overrides the normal server_bind() function
2657
1716
to bind to an interface if one was specified, and also NOT to
2658
1717
bind to an address or port if they were not specified."""
2659
global SO_BINDTODEVICE
2660
1718
if self.interface is not None:
2661
1719
if SO_BINDTODEVICE is None:
2662
# Fall back to a hard-coded value which seems to be
2663
# common enough.
2664
log.warning("SO_BINDTODEVICE not found, trying 25")
2665
SO_BINDTODEVICE = 25
2666
try:
2667
self.socket.setsockopt(
2668
socket.SOL_SOCKET, SO_BINDTODEVICE,
2669
(self.interface + "\0").encode("utf-8"))
2670
except socket.error as error:
2671
if error.errno == errno.EPERM:
2672
log.error("No permission to bind to interface %s",
2673
self.interface)
2674
elif error.errno == errno.ENOPROTOOPT:
2675
log.error("SO_BINDTODEVICE not available; cannot"
2676
" bind to interface %s", self.interface)
2677
elif error.errno == errno.ENODEV:
2678
log.error("Interface %s does not exist, cannot"
2679
" bind", self.interface)
2680
else:
2681
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
2682
1740
# Only bind(2) the socket if we really need to.
2683
1741
if self.server_address[0] or self.server_address[1]:
2684
if self.server_address[1]:
2685
self.allow_reuse_address = True
2686
1742
if not self.server_address[0]:
2687
1743
if self.address_family == socket.AF_INET6:
2688
any_address = "::" # in6addr_any
1744
any_address = "::" # in6addr_any
2689
1745
else:
2690
any_address = "0.0.0.0" # INADDR_ANY
1746
any_address = socket.INADDR_ANY
2691
1747
self.server_address = (any_address,
2692
1748
self.server_address[1])
2693
1749
elif not self.server_address[1]:
2694
self.server_address = (self.server_address[0], 0)
1750
self.server_address = (self.server_address[0],
1751
0)
2695
1752
# if self.interface:
2696
1753
# self.server_address = (self.server_address[0],
2697
1754
# 0, # port
2703
1760
2704
1761
class MandosServer(IPv6_TCPServer):
2705
1762
"""Mandos server.
2706
1763
2707
1764
Attributes:
2708
1765
clients: set of Client objects
2709
1766
gnutls_priority GnuTLS priority string
2710
1767
use_dbus: Boolean; to emit D-Bus signals or not
2711
2712
Assumes a GLib.MainLoop event loop.
1768
1769
Assumes a gobject.MainLoop event loop.
2713
1770
"""
2714
2715
1771
def __init__(self, server_address, RequestHandlerClass,
2716
interface=None,
2717
use_ipv6=True,
2718
clients=None,
2719
gnutls_priority=None,
2720
use_dbus=True,
2721
socketfd=None):
1772
interface=None, use_ipv6=True, clients=None,
1773
gnutls_priority=None, use_dbus=True):
2722
1774
self.enabled = False
2723
1775
self.clients = clients
2724
1776
if self.clients is None:
2727
1779
self.gnutls_priority = gnutls_priority
2728
1780
IPv6_TCPServer.__init__(self, server_address,
2729
1781
RequestHandlerClass,
2730
interface=interface,
2731
use_ipv6=use_ipv6,
2732
socketfd=socketfd)
2733
1782
interface = interface,
1783
use_ipv6 = use_ipv6)
2734
1784
def server_activate(self):
2735
1785
if self.enabled:
2736
1786
return socketserver.TCPServer.server_activate(self)
2737
1787
2738
1788
def enable(self):
2739
1789
self.enabled = True
2740
1790
2741
1791
def add_pipe(self, parent_pipe, proc):
2742
1792
# Call "handle_ipc" for both data and EOF events
2743
GLib.io_add_watch(
2744
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2745
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2746
functools.partial(self.handle_ipc,
2747
parent_pipe=parent_pipe,
2748
proc=proc))
2749
2750
def handle_ipc(self, source, condition,
2751
parent_pipe=None,
2752
proc=None,
2753
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)
2754
1816
# error, or the other end of multiprocessing.Pipe has closed
2755
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1817
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2756
1818
# Wait for other process to exit
2757
1819
proc.join()
2758
1820
return False
2759
1821
2760
1822
# Read a request from the child
2761
1823
request = parent_pipe.recv()
2762
1824
command = request[0]
2763
2764
if command == "init":
2765
key_id = request[1].decode("ascii")
2766
fpr = request[2].decode("ascii")
2767
address = request[3]
2768
2769
for c in self.clients.values():
2770
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2771
"27AE41E4649B934CA495991B7852B855"):
2772
continue
2773
if key_id and c.key_id == key_id:
2774
client = c
2775
break
2776
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:
2777
1832
client = c
2778
1833
break
2779
1834
else:
2780
log.info("Client not found for key ID: %s, address:"
2781
" %s", key_id or fpr, address)
1835
logger.info("Client not found for fingerprint: %s, ad"
1836
"dress: %s", fpr, address)
2782
1837
if self.use_dbus:
2783
1838
# Emit D-Bus signal
2784
mandos_dbus_service.ClientNotFound(key_id or fpr,
1839
mandos_dbus_service.ClientNotFound(fpr,
2785
1840
address[0])
2786
1841
parent_pipe.send(False)
2787
1842
return False
2788
2789
GLib.io_add_watch(
2790
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2791
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2792
functools.partial(self.handle_ipc,
2793
parent_pipe=parent_pipe,
2794
proc=proc,
2795
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))
2796
1852
parent_pipe.send(True)
2797
1853
# remove the old hook in favor of the new above hook on
2798
1854
# same fileno
2799
1855
return False
2800
if command == "funcall":
1856
if command == 'funcall':
2801
1857
funcname = request[1]
2802
1858
args = request[2]
2803
1859
kwargs = request[3]
2804
2805
parent_pipe.send(("data", getattr(client_object,
1860
1861
parent_pipe.send(('data', getattr(client_object,
2806
1862
funcname)(*args,
2807
**kwargs)))
2808
2809
if command == "getattr":
1863
**kwargs)))
1864
1865
if command == 'getattr':
2810
1866
attrname = request[1]
2811
if isinstance(client_object.__getattribute__(attrname),
2812
collections.abc.Callable):
2813
parent_pipe.send(("function", ))
1867
if callable(client_object.__getattribute__(attrname)):
1868
parent_pipe.send(('function',))
2814
1869
else:
2815
parent_pipe.send((
2816
"data", client_object.__getattribute__(attrname)))
2817
2818
if command == "setattr":
1870
parent_pipe.send(('data', client_object
1871
.__getattribute__(attrname)))
1872
1873
if command == 'setattr':
2819
1874
attrname = request[1]
2820
1875
value = request[2]
2821
1876
setattr(client_object, attrname, value)
2822
1877
2823
1878
return True
2824
1879
2825
1880
2826
def rfc3339_duration_to_delta(duration):
2827
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2828
2829
>>> timedelta = datetime.timedelta
2830
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2831
True
2832
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2833
True
2834
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2835
True
2836
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2837
True
2838
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2839
True
2840
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2841
True
2842
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2843
True
2844
>>> del timedelta
2845
"""
2846
2847
# Parsing an RFC 3339 duration with regular expressions is not
2848
# possible - there would have to be multiple places for the same
2849
# values, like seconds. The current code, while more esoteric, is
2850
# cleaner without depending on a parsing library. If Python had a
2851
# built-in library for parsing we would use it, but we'd like to
2852
# avoid excessive use of external libraries.
2853
2854
# New type for defining tokens, syntax, and semantics all-in-one
2855
Token = collections.namedtuple("Token", (
2856
"regexp", # To match token; if "value" is not None, must have
2857
# a "group" containing digits
2858
"value", # datetime.timedelta or None
2859
"followers")) # Tokens valid after this token
2860
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2861
# the "duration" ABNF definition in RFC 3339, Appendix A.
2862
token_end = Token(re.compile(r"$"), None, frozenset())
2863
token_second = Token(re.compile(r"(\d+)S"),
2864
datetime.timedelta(seconds=1),
2865
frozenset((token_end, )))
2866
token_minute = Token(re.compile(r"(\d+)M"),
2867
datetime.timedelta(minutes=1),
2868
frozenset((token_second, token_end)))
2869
token_hour = Token(re.compile(r"(\d+)H"),
2870
datetime.timedelta(hours=1),
2871
frozenset((token_minute, token_end)))
2872
token_time = Token(re.compile(r"T"),
2873
None,
2874
frozenset((token_hour, token_minute,
2875
token_second)))
2876
token_day = Token(re.compile(r"(\d+)D"),
2877
datetime.timedelta(days=1),
2878
frozenset((token_time, token_end)))
2879
token_month = Token(re.compile(r"(\d+)M"),
2880
datetime.timedelta(weeks=4),
2881
frozenset((token_day, token_end)))
2882
token_year = Token(re.compile(r"(\d+)Y"),
2883
datetime.timedelta(weeks=52),
2884
frozenset((token_month, token_end)))
2885
token_week = Token(re.compile(r"(\d+)W"),
2886
datetime.timedelta(weeks=1),
2887
frozenset((token_end, )))
2888
token_duration = Token(re.compile(r"P"), None,
2889
frozenset((token_year, token_month,
2890
token_day, token_time,
2891
token_week)))
2892
# Define starting values:
2893
# Value so far
2894
value = datetime.timedelta()
2895
found_token = None
2896
# Following valid tokens
2897
followers = frozenset((token_duration, ))
2898
# String left to parse
2899
s = duration
2900
# Loop until end token is found
2901
while found_token is not token_end:
2902
# Search for any currently valid tokens
2903
for token in followers:
2904
match = token.regexp.match(s)
2905
if match is not None:
2906
# Token found
2907
if token.value is not None:
2908
# Value found, parse digits
2909
factor = int(match.group(1), 10)
2910
# Add to value so far
2911
value += factor * token.value
2912
# Strip token from string
2913
s = token.regexp.sub("", s, 1)
2914
# Go to found token
2915
found_token = token
2916
# Set valid next tokens
2917
followers = found_token.followers
2918
break
2919
else:
2920
# No currently valid tokens were found
2921
raise ValueError("Invalid RFC 3339 duration: {!r}"
2922
.format(duration))
2923
# End token found
2924
return value
2925
2926
2927
1881
def string_to_delta(interval):
2928
1882
"""Parse a string and return a datetime.timedelta
2929
2930
>>> string_to_delta("7d") == datetime.timedelta(7)
2931
True
2932
>>> string_to_delta("60s") == datetime.timedelta(0, 60)
2933
True
2934
>>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2935
True
2936
>>> string_to_delta("24h") == datetime.timedelta(1)
2937
True
2938
>>> string_to_delta("1w") == datetime.timedelta(7)
2939
True
2940
>>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2941
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)
2942
1896
"""
2943
2944
try:
2945
return rfc3339_duration_to_delta(interval)
2946
except ValueError:
2947
pass
2948
2949
1897
timevalue = datetime.timedelta(0)
2950
1898
for s in interval.split():
2951
1899
try:
2952
suffix = s[-1]
1900
suffix = unicode(s[-1])
2953
1901
value = int(s[:-1])
2954
1902
if suffix == "d":
2955
1903
delta = datetime.timedelta(value)
2962
1910
elif suffix == "w":
2963
1911
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2964
1912
else:
2965
raise ValueError("Unknown suffix {!r}".format(suffix))
2966
except IndexError as e:
1913
raise ValueError("Unknown suffix %r" % suffix)
1914
except (ValueError, IndexError) as e:
2967
1915
raise ValueError(*(e.args))
2968
1916
timevalue += delta
2969
1917
return timevalue
2970
1918
2971
1919
2972
def daemon(nochdir=False, noclose=False):
1920
def daemon(nochdir = False, noclose = False):
2973
1921
"""See daemon(3). Standard BSD Unix function.
2974
1922
2975
1923
This should really exist as os.daemon, but it doesn't (yet)."""
2976
1924
if os.fork():
2977
1925
sys.exit()
2982
1930
sys.exit()
2983
1931
if not noclose:
2984
1932
# Close all standard open file descriptors
2985
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1933
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2986
1934
if not stat.S_ISCHR(os.fstat(null).st_mode):
2987
1935
raise OSError(errno.ENODEV,
2988
"{} not a character device"
2989
.format(os.devnull))
1936
"%s not a character device"
1937
% os.path.devnull)
2990
1938
os.dup2(null, sys.stdin.fileno())
2991
1939
os.dup2(null, sys.stdout.fileno())
2992
1940
os.dup2(null, sys.stderr.fileno())
2995
1943
2996
1944
2997
1945
def main():
2998
1946
2999
1947
##################################################################
3000
1948
# Parsing of options, both command line and config file
3001
1949
3002
1950
parser = argparse.ArgumentParser()
3003
1951
parser.add_argument("-v", "--version", action="version",
3004
version="%(prog)s {}".format(version),
1952
version = "%%(prog)s %s" % version,
3005
1953
help="show version number and exit")
3006
1954
parser.add_argument("-i", "--interface", metavar="IF",
3007
1955
help="Bind to interface IF")
3013
1961
help="Run self-test")
3014
1962
parser.add_argument("--debug", action="store_true",
3015
1963
help="Debug mode; run in foreground and log"
3016
" to terminal", default=None)
1964
" to terminal")
3017
1965
parser.add_argument("--debuglevel", metavar="LEVEL",
3018
1966
help="Debug level for stdout output")
3019
1967
parser.add_argument("--priority", help="GnuTLS"
3026
1974
" files")
3027
1975
parser.add_argument("--no-dbus", action="store_false",
3028
1976
dest="use_dbus", help="Do not provide D-Bus"
3029
" system bus interface", default=None)
1977
" system bus interface")
3030
1978
parser.add_argument("--no-ipv6", action="store_false",
3031
dest="use_ipv6", help="Do not use IPv6",
3032
default=None)
1979
dest="use_ipv6", help="Do not use IPv6")
3033
1980
parser.add_argument("--no-restore", action="store_false",
3034
1981
dest="restore", help="Do not restore stored"
3035
" state", default=None)
3036
parser.add_argument("--socket", type=int,
3037
help="Specify a file descriptor to a network"
3038
" socket to use instead of creating one")
1982
" state")
3039
1983
parser.add_argument("--statedir", metavar="DIR",
3040
1984
help="Directory to save/restore state in")
3041
parser.add_argument("--foreground", action="store_true",
3042
help="Run in foreground", default=None)
3043
parser.add_argument("--no-zeroconf", action="store_false",
3044
dest="zeroconf", help="Do not use Zeroconf",
3045
default=None)
3046
1985
3047
1986
options = parser.parse_args()
3048
1987
1988
if options.check:
1989
import doctest
1990
doctest.testmod()
1991
sys.exit()
1992
3049
1993
# Default values for config file for server-global settings
3050
if gnutls.has_rawpk:
3051
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3052
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3053
else:
3054
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3055
":+SIGN-DSA-SHA256")
3056
server_defaults = {"interface": "",
3057
"address": "",
3058
"port": "",
3059
"debug": "False",
3060
"priority": priority,
3061
"servicename": "Mandos",
3062
"use_dbus": "True",
3063
"use_ipv6": "True",
3064
"debuglevel": "",
3065
"restore": "True",
3066
"socket": "",
3067
"statedir": "/var/lib/mandos",
3068
"foreground": "False",
3069
"zeroconf": "True",
3070
}
3071
del priority
3072
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
3073
2008
# Parse config file for server-global settings
3074
server_config = configparser.ConfigParser(server_defaults)
2009
server_config = configparser.SafeConfigParser(server_defaults)
3075
2010
del server_defaults
3076
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3077
# 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
3078
2014
server_settings = server_config.defaults()
3079
2015
# Use the appropriate methods on the non-string config options
3080
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3081
"foreground", "zeroconf"):
2016
for option in ("debug", "use_dbus", "use_ipv6"):
3082
2017
server_settings[option] = server_config.getboolean("DEFAULT",
3083
2018
option)
3084
2019
if server_settings["port"]:
3085
2020
server_settings["port"] = server_config.getint("DEFAULT",
3086
2021
"port")
3087
if server_settings["socket"]:
3088
server_settings["socket"] = server_config.getint("DEFAULT",
3089
"socket")
3090
# Later, stdin will, and stdout and stderr might, be dup'ed
3091
# over with an opened os.devnull. But we don't want this to
3092
# happen with a supplied network socket.
3093
if 0 <= server_settings["socket"] <= 2:
3094
server_settings["socket"] = os.dup(server_settings
3095
["socket"])
3096
2022
del server_config
3097
2023
3098
2024
# Override the settings from the config file with command line
3099
2025
# options, if set.
3100
2026
for option in ("interface", "address", "port", "debug",
3101
"priority", "servicename", "configdir", "use_dbus",
3102
"use_ipv6", "debuglevel", "restore", "statedir",
3103
"socket", "foreground", "zeroconf"):
2027
"priority", "servicename", "configdir",
2028
"use_dbus", "use_ipv6", "debuglevel", "restore",
2029
"statedir"):
3104
2030
value = getattr(options, option)
3105
2031
if value is not None:
3106
2032
server_settings[option] = value
3107
2033
del options
3108
2034
# Force all strings to be unicode
3109
2035
for option in server_settings.keys():
3110
if isinstance(server_settings[option], bytes):
3111
server_settings[option] = (server_settings[option]
3112
.decode("utf-8"))
3113
# Force all boolean options to be boolean
3114
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3115
"foreground", "zeroconf"):
3116
server_settings[option] = bool(server_settings[option])
3117
# Debug implies foreground
3118
if server_settings["debug"]:
3119
server_settings["foreground"] = True
2036
if type(server_settings[option]) is str:
2037
server_settings[option] = unicode(server_settings[option])
3120
2038
# Now we have our good server settings in "server_settings"
3121
2039
3122
2040
##################################################################
3123
3124
if (not server_settings["zeroconf"]
3125
and not (server_settings["port"]
3126
or server_settings["socket"] != "")):
3127
parser.error("Needs port or socket to work without Zeroconf")
3128
2041
3129
2042
# For convenience
3130
2043
debug = server_settings["debug"]
3131
2044
debuglevel = server_settings["debuglevel"]
3133
2046
use_ipv6 = server_settings["use_ipv6"]
3134
2047
stored_state_path = os.path.join(server_settings["statedir"],
3135
2048
stored_state_file)
3136
foreground = server_settings["foreground"]
3137
zeroconf = server_settings["zeroconf"]
3138
2049
3139
2050
if debug:
3140
initlogger(debug, logging.DEBUG)
2051
initlogger(logging.DEBUG)
3141
2052
else:
3142
2053
if not debuglevel:
3143
initlogger(debug)
2054
initlogger()
3144
2055
else:
3145
2056
level = getattr(logging, debuglevel.upper())
3146
initlogger(debug, level)
3147
2057
initlogger(level)
2058
3148
2059
if server_settings["servicename"] != "Mandos":
3149
syslogger.setFormatter(
3150
logging.Formatter("Mandos ({}) [%(process)d]:"
3151
" %(levelname)s: %(message)s".format(
3152
server_settings["servicename"])))
3153
2060
syslogger.setFormatter(logging.Formatter
2061
('Mandos (%s) [%%(process)d]:'
2062
' %%(levelname)s: %%(message)s'
2063
% server_settings["servicename"]))
2064
3154
2065
# Parse config file with clients
3155
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)
3156
2075
client_config.read(os.path.join(server_settings["configdir"],
3157
2076
"clients.conf"))
3158
2077
3159
2078
global mandos_dbus_service
3160
2079
mandos_dbus_service = None
3161
3162
socketfd = None
3163
if server_settings["socket"] != "":
3164
socketfd = server_settings["socket"]
3165
tcp_server = MandosServer(
3166
(server_settings["address"], server_settings["port"]),
3167
ClientHandler,
3168
interface=(server_settings["interface"] or None),
3169
use_ipv6=use_ipv6,
3170
gnutls_priority=server_settings["priority"],
3171
use_dbus=use_dbus,
3172
socketfd=socketfd)
3173
if not foreground:
3174
pidfilename = "/run/mandos.pid"
3175
if not os.path.isdir("/run/."):
3176
pidfilename = "/var/run/mandos.pid"
3177
pidfile = None
3178
try:
3179
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3180
except IOError as e:
3181
log.error("Could not open file %r", pidfilename,
3182
exc_info=e)
3183
3184
for name, group in (("_mandos", "_mandos"),
3185
("mandos", "mandos"),
3186
("nobody", "nogroup")):
3187
try:
3188
uid = pwd.getpwnam(name).pw_uid
3189
gid = pwd.getpwnam(group).pw_gid
3190
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
3191
2104
except KeyError:
3192
continue
3193
else:
3194
uid = 65534
3195
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
3196
2111
try:
3197
2112
os.setgid(gid)
3198
2113
os.setuid(uid)
3199
log.debug("Did setuid/setgid to %s:%s", uid, gid)
3200
2114
except OSError as error:
3201
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3202
os.strerror(error.errno))
3203
if error.errno != errno.EPERM:
3204
raise
3205
2115
if error[0] != errno.EPERM:
2116
raise error
2117
3206
2118
if debug:
3207
2119
# Enable all possible GnuTLS debugging
3208
2120
3209
2121
# "Use a log level over 10 to enable all debugging options."
3210
2122
# - GnuTLS manual
3211
gnutls.global_set_log_level(11)
3212
3213
@gnutls.log_func
2123
gnutls.library.functions.gnutls_global_set_log_level(11)
2124
2125
@gnutls.library.types.gnutls_log_func
3214
2126
def debug_gnutls(level, string):
3215
log.debug("GnuTLS: %s",
3216
string[:-1].decode("utf-8", errors="replace"))
3217
3218
gnutls.global_set_log_function(debug_gnutls)
3219
2127
logger.debug("GnuTLS: %s", string[:-1])
2128
2129
(gnutls.library.functions
2130
.gnutls_global_set_log_function(debug_gnutls))
2131
3220
2132
# Redirect stdin so all checkers get /dev/null
3221
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2133
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3222
2134
os.dup2(null, sys.stdin.fileno())
3223
2135
if null > 2:
3224
2136
os.close(null)
3225
2137
else:
2138
# No console logging
2139
logger.removeHandler(console)
2140
3226
2141
# Need to fork before connecting to D-Bus
3227
if not foreground:
2142
if not debug:
3228
2143
# Close all input and output, do double fork, etc.
3229
2144
daemon()
3230
3231
if gi.version_info < (3, 10, 2):
3232
# multiprocessing will use threads, so before we use GLib we
3233
# need to inform GLib that threads will be used.
3234
GLib.threads_init()
3235
2145
3236
2146
global main_loop
3237
2147
# From the Avahi example code
3238
DBusGMainLoop(set_as_default=True)
3239
main_loop = GLib.MainLoop()
2148
DBusGMainLoop(set_as_default=True )
2149
main_loop = gobject.MainLoop()
3240
2150
bus = dbus.SystemBus()
3241
2151
# End of Avahi example code
3242
2152
if use_dbus:
3243
2153
try:
3244
2154
bus_name = dbus.service.BusName("se.recompile.Mandos",
3245
bus,
3246
do_not_queue=True)
3247
old_bus_name = dbus.service.BusName(
3248
"se.bsnet.fukt.Mandos", bus,
3249
do_not_queue=True)
3250
except dbus.exceptions.DBusException as e:
3251
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")
3252
2161
use_dbus = False
3253
2162
server_settings["use_dbus"] = False
3254
2163
tcp_server.use_dbus = False
3255
if zeroconf:
3256
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3257
service = AvahiServiceToSyslog(
3258
name=server_settings["servicename"],
3259
servicetype="_mandos._tcp",
3260
protocol=protocol,
3261
bus=bus)
3262
if server_settings["interface"]:
3263
service.interface = if_nametoindex(
3264
server_settings["interface"].encode("utf-8"))
3265
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
3266
2173
global multiprocessing_manager
3267
2174
multiprocessing_manager = multiprocessing.Manager()
3268
2175
3269
2176
client_class = Client
3270
2177
if use_dbus:
3271
client_class = functools.partial(ClientDBus, bus=bus)
3272
3273
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
3274
2204
old_client_settings = {}
3275
clients_data = {}
3276
3277
# This is used to redirect stdout and stderr for checker processes
3278
global wnull
3279
wnull = open(os.devnull, "w") # A writable /dev/null
3280
# Only used if server is running in foreground but not in debug
3281
# mode
3282
if debug or not foreground:
3283
wnull.close()
3284
2205
clients_data = []
2206
3285
2207
# Get client data and settings from last running state.
3286
2208
if server_settings["restore"]:
3287
2209
try:
3288
2210
with open(stored_state_path, "rb") as stored_state:
3289
if sys.version_info.major == 2:
3290
clients_data, old_client_settings = pickle.load(
3291
stored_state)
3292
else:
3293
bytes_clients_data, bytes_old_client_settings = (
3294
pickle.load(stored_state, encoding="bytes"))
3295
# Fix bytes to strings
3296
# clients_data
3297
# .keys()
3298
clients_data = {(key.decode("utf-8")
3299
if isinstance(key, bytes)
3300
else key): value
3301
for key, value in
3302
bytes_clients_data.items()}
3303
del bytes_clients_data
3304
for key in clients_data:
3305
value = {(k.decode("utf-8")
3306
if isinstance(k, bytes) else k): v
3307
for k, v in
3308
clients_data[key].items()}
3309
clients_data[key] = value
3310
# .client_structure
3311
value["client_structure"] = [
3312
(s.decode("utf-8")
3313
if isinstance(s, bytes)
3314
else s) for s in
3315
value["client_structure"]]
3316
# .name, .host, and .checker_command
3317
for k in ("name", "host", "checker_command"):
3318
if isinstance(value[k], bytes):
3319
value[k] = value[k].decode("utf-8")
3320
if "key_id" not in value:
3321
value["key_id"] = ""
3322
elif "fingerprint" not in value:
3323
value["fingerprint"] = ""
3324
# old_client_settings
3325
# .keys()
3326
old_client_settings = {
3327
(key.decode("utf-8")
3328
if isinstance(key, bytes)
3329
else key): value
3330
for key, value in
3331
bytes_old_client_settings.items()}
3332
del bytes_old_client_settings
3333
# .host and .checker_command
3334
for value in old_client_settings.values():
3335
for attribute in ("host", "checker_command"):
3336
if isinstance(value[attribute], bytes):
3337
value[attribute] = (value[attribute]
3338
.decode("utf-8"))
2211
clients_data, old_client_settings = (pickle.load
2212
(stored_state))
3339
2213
os.remove(stored_state_path)
3340
2214
except IOError as e:
3341
if e.errno == errno.ENOENT:
3342
log.warning("Could not load persistent state:"
3343
" %s", os.strerror(e.errno))
3344
else:
3345
log.critical("Could not load persistent state:",
3346
exc_info=e)
2215
logger.warning("Could not load persistent state: {0}"
2216
.format(e))
2217
if e.errno != errno.ENOENT:
3347
2218
raise
3348
except EOFError as e:
3349
log.warning("Could not load persistent state: EOFError:",
3350
exc_info=e)
3351
3352
with PGPEngine() as pgp:
3353
for client_name, client in clients_data.items():
3354
# Skip removed clients
3355
if client_name not in client_settings:
3356
continue
3357
2219
2220
with Crypto() as crypt:
2221
for client in clients_data:
2222
client_name = client["name"]
2223
3358
2224
# Decide which value to use after restoring saved state.
3359
2225
# We have three different values: Old config file,
3360
2226
# new config file, and saved state.
3365
2231
# For each value in new config, check if it
3366
2232
# differs from the old config value (Except for
3367
2233
# the "secret" attribute)
3368
if (name != "secret"
3369
and (value !=
3370
old_client_settings[client_name][name])):
3371
client[name] = value
2234
if (name != "secret" and
2235
value != old_client_settings[client_name]
2236
[name]):
2237
setattr(client, name, value)
3372
2238
except KeyError:
3373
2239
pass
3374
2240
3375
2241
# Clients who has passed its expire date can still be
3376
# enabled if its last checker was successful. A Client
3377
# whose checker succeeded before we stored its state is
3378
# assumed to have successfully run all checkers during
3379
# downtime.
3380
if client["enabled"]:
3381
if datetime.datetime.utcnow() >= client["expires"]:
3382
if not client["last_checked_ok"]:
3383
log.warning("disabling client %s - Client"
3384
" never performed a successful"
3385
" checker", client_name)
3386
client["enabled"] = False
3387
elif client["last_checker_status"] != 0:
3388
log.warning("disabling client %s - Client"
3389
" last checker failed with error"
3390
" code %s", client_name,
3391
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:
3392
2250
client["enabled"] = False
3393
2251
else:
3394
client["expires"] = (
3395
datetime.datetime.utcnow()
3396
+ client["timeout"])
3397
log.debug("Last checker succeeded, keeping %s"
3398
" 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
3399
2284
try:
3400
client["secret"] = pgp.decrypt(
3401
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 = (
3402
2293
client_settings[client_name]["secret"])
3403
except PGPError:
3404
# If decryption fails, we use secret from new settings
3405
log.debug("Failed to decrypt %s old secret",
3406
client_name)
3407
client["secret"] = (client_settings[client_name]
3408
["secret"])
3409
3410
# Add/remove clients based on new changes made to config
3411
for client_name in (set(old_client_settings)
3412
- set(client_settings)):
3413
del clients_data[client_name]
3414
for client_name in (set(client_settings)
3415
- set(old_client_settings)):
3416
clients_data[client_name] = client_settings[client_name]
3417
3418
# Create all client objects
3419
for client_name, client in clients_data.items():
3420
tcp_server.clients[client_name] = client_class(
3421
name=client_name,
3422
settings=client,
3423
server_settings=server_settings)
3424
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
3425
2305
if not tcp_server.clients:
3426
log.warning("No clients defined")
3427
3428
if not foreground:
3429
if pidfile is not None:
3430
pid = os.getpid()
3431
try:
3432
with pidfile:
3433
print(pid, file=pidfile)
3434
except IOError:
3435
log.error("Could not write to file %r with PID %d",
3436
pidfilename, pid)
3437
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
3438
2320
del pidfilename
3439
3440
for termsig in (signal.SIGHUP, signal.SIGTERM):
3441
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3442
lambda: main_loop.quit() and False)
3443
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
3444
2327
if use_dbus:
3445
3446
@alternate_dbus_interfaces(
3447
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3448
class MandosDBusService(DBusObjectWithObjectManager):
2328
class MandosDBusService(dbus.service.Object):
3449
2329
"""A D-Bus proxy object"""
3450
3451
2330
def __init__(self):
3452
2331
dbus.service.Object.__init__(self, bus, "/")
3453
3454
2332
_interface = "se.recompile.Mandos"
3455
2333
3456
2334
@dbus.service.signal(_interface, signature="o")
3457
2335
def ClientAdded(self, objpath):
3458
2336
"D-Bus signal"
3459
2337
pass
3460
2338
3461
2339
@dbus.service.signal(_interface, signature="ss")
3462
def ClientNotFound(self, key_id, address):
2340
def ClientNotFound(self, fingerprint, address):
3463
2341
"D-Bus signal"
3464
2342
pass
3465
3466
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3467
"true"})
2343
3468
2344
@dbus.service.signal(_interface, signature="os")
3469
2345
def ClientRemoved(self, objpath, name):
3470
2346
"D-Bus signal"
3471
2347
pass
3472
3473
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3474
"true"})
2348
3475
2349
@dbus.service.method(_interface, out_signature="ao")
3476
2350
def GetAllClients(self):
3477
2351
"D-Bus method"
3478
return dbus.Array(c.dbus_object_path for c in
3479
tcp_server.clients.values())
3480
3481
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3482
"true"})
2352
return dbus.Array(c.dbus_object_path
2353
for c in
2354
tcp_server.clients.itervalues())
2355
3483
2356
@dbus.service.method(_interface,
3484
2357
out_signature="a{oa{sv}}")
3485
2358
def GetAllClientsWithProperties(self):
3486
2359
"D-Bus method"
3487
2360
return dbus.Dictionary(
3488
{c.dbus_object_path: c.GetAll(
3489
"se.recompile.Mandos.Client")
3490
for c in tcp_server.clients.values()},
2361
((c.dbus_object_path, c.GetAll(""))
2362
for c in tcp_server.clients.itervalues()),
3491
2363
signature="oa{sv}")
3492
2364
3493
2365
@dbus.service.method(_interface, in_signature="o")
3494
2366
def RemoveClient(self, object_path):
3495
2367
"D-Bus method"
3496
for c in tcp_server.clients.values():
2368
for c in tcp_server.clients.itervalues():
3497
2369
if c.dbus_object_path == object_path:
3498
2370
del tcp_server.clients[c.name]
3499
2371
c.remove_from_connection()
3500
# Don't signal the disabling
2372
# Don't signal anything except ClientRemoved
3501
2373
c.disable(quiet=True)
3502
# Emit D-Bus signal for removal
3503
self.client_removed_signal(c)
2374
# Emit D-Bus signal
2375
self.ClientRemoved(object_path, c.name)
3504
2376
return
3505
2377
raise KeyError(object_path)
3506
2378
3507
2379
del _interface
3508
3509
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3510
out_signature="a{oa{sa{sv}}}")
3511
def GetManagedObjects(self):
3512
"""D-Bus method"""
3513
return dbus.Dictionary(
3514
{client.dbus_object_path:
3515
dbus.Dictionary(
3516
{interface: client.GetAll(interface)
3517
for interface in
3518
client._get_all_interface_names()})
3519
for client in tcp_server.clients.values()})
3520
3521
def client_added_signal(self, client):
3522
"""Send the new standard signal and the old signal"""
3523
if use_dbus:
3524
# New standard signal
3525
self.InterfacesAdded(
3526
client.dbus_object_path,
3527
dbus.Dictionary(
3528
{interface: client.GetAll(interface)
3529
for interface in
3530
client._get_all_interface_names()}))
3531
# Old signal
3532
self.ClientAdded(client.dbus_object_path)
3533
3534
def client_removed_signal(self, client):
3535
"""Send the new standard signal and the old signal"""
3536
if use_dbus:
3537
# New standard signal
3538
self.InterfacesRemoved(
3539
client.dbus_object_path,
3540
client._get_all_interface_names())
3541
# Old signal
3542
self.ClientRemoved(client.dbus_object_path,
3543
client.name)
3544
3545
mandos_dbus_service = MandosDBusService()
3546
3547
# Save modules to variables to exempt the modules from being
3548
# unloaded before the function registered with atexit() is run.
3549
mp = multiprocessing
3550
wn = wnull
3551
2380
2381
class MandosDBusServiceTransitional(MandosDBusService):
2382
__metaclass__ = AlternateDBusNamesMetaclass
2383
mandos_dbus_service = MandosDBusServiceTransitional()
2384
3552
2385
def cleanup():
3553
2386
"Cleanup function; run on exit"
3554
if zeroconf:
3555
service.cleanup()
3556
3557
mp.active_children()
3558
wn.close()
2387
service.cleanup()
2388
2389
multiprocessing.active_children()
3559
2390
if not (tcp_server.clients or client_settings):
3560
2391
return
3561
2392
3562
2393
# Store client before exiting. Secrets are encrypted with key
3563
2394
# based on what config file has. If config file is
3564
2395
# removed/edited, old secret will thus be unrecovable.
3565
clients = {}
3566
with PGPEngine() as pgp:
3567
for client in tcp_server.clients.values():
2396
clients = []
2397
with Crypto() as crypt:
2398
for client in tcp_server.clients.itervalues():
3568
2399
key = client_settings[client.name]["secret"]
3569
client.encrypted_secret = pgp.encrypt(client.secret,
3570
key)
2400
client.encrypted_secret = crypt.encrypt(client.secret,
2401
key)
3571
2402
client_dict = {}
3572
3573
# A list of attributes that can not be pickled
3574
# + secret.
3575
exclude = {"bus", "changedstate", "secret",
3576
"checker", "server_settings"}
3577
for name, typ in inspect.getmembers(dbus.service
3578
.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)):
3579
2409
exclude.add(name)
3580
2410
3581
2411
client_dict["encrypted_secret"] = (client
3582
2412
.encrypted_secret)
3583
2413
for attr in client.client_structure:
3584
2414
if attr not in exclude:
3585
2415
client_dict[attr] = getattr(client, attr)
3586
3587
clients[client.name] = client_dict
2416
2417
clients.append(client_dict)
3588
2418
del client_settings[client.name]["secret"]
3589
2419
3590
2420
try:
3591
with tempfile.NamedTemporaryFile(
3592
mode="wb",
3593
suffix=".pickle",
3594
prefix="clients-",
3595
dir=os.path.dirname(stored_state_path),
3596
delete=False) as stored_state:
3597
pickle.dump((clients, client_settings), stored_state,
3598
protocol=2)
3599
tempname = stored_state.name
3600
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)
3601
2425
except (IOError, OSError) as e:
3602
if not debug:
3603
try:
3604
os.remove(tempname)
3605
except NameError:
3606
pass
3607
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3608
log.warning("Could not save persistent state: %s",
3609
os.strerror(e.errno))
3610
else:
3611
log.warning("Could not save persistent state:",
3612
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):
3613
2429
raise
3614
2430
3615
2431
# Delete all clients, and settings from config
3616
2432
while tcp_server.clients:
3617
2433
name, client = tcp_server.clients.popitem()
3618
2434
if use_dbus:
3619
2435
client.remove_from_connection()
3620
# Don't signal the disabling
2436
# Don't signal anything except ClientRemoved
3621
2437
client.disable(quiet=True)
3622
# Emit D-Bus signal for removal
3623
2438
if use_dbus:
3624
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)
3625
2443
client_settings.clear()
3626
2444
3627
2445
atexit.register(cleanup)
3628
3629
for client in tcp_server.clients.values():
2446
2447
for client in tcp_server.clients.itervalues():
3630
2448
if use_dbus:
3631
# Emit D-Bus signal for adding
3632
mandos_dbus_service.client_added_signal(client)
2449
# Emit D-Bus signal
2450
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3633
2451
# Need to initiate checking of clients
3634
2452
if client.enabled:
3635
client.init_checker(randomize_start=True)
3636
2453
client.init_checker()
2454
3637
2455
tcp_server.enable()
3638
2456
tcp_server.server_activate()
3639
2457
3640
2458
# Find out what port we got
3641
if zeroconf:
3642
service.port = tcp_server.socket.getsockname()[1]
2459
service.port = tcp_server.socket.getsockname()[1]
3643
2460
if use_ipv6:
3644
log.info("Now listening on address %r, port %d, flowinfo %d,"
3645
" 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())
3646
2464
else: # IPv4
3647
log.info("Now listening on address %r, port %d",
3648
*tcp_server.socket.getsockname())
3649
3650
# service.interface = tcp_server.socket.getsockname()[3]
3651
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
3652
2470
try:
3653
if zeroconf:
3654
# From the Avahi example code
3655
try:
3656
service.activate()
3657
except dbus.exceptions.DBusException as error:
3658
log.critical("D-Bus Exception", exc_info=error)
3659
cleanup()
3660
sys.exit(1)
3661
# End of Avahi example code
3662
3663
GLib.io_add_watch(
3664
GLib.IOChannel.unix_new(tcp_server.fileno()),
3665
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3666
lambda *args, **kwargs: (tcp_server.handle_request
3667
(*args[2:], **kwargs) or True))
3668
3669
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")
3670
2486
main_loop.run()
3671
2487
except AvahiError as error:
3672
log.critical("Avahi Error", exc_info=error)
2488
logger.critical("AvahiError: %s", error)
3673
2489
cleanup()
3674
2490
sys.exit(1)
3675
2491
except KeyboardInterrupt:
3676
2492
if debug:
3677
2493
print("", file=sys.stderr)
3678
log.debug("Server received KeyboardInterrupt")
3679
log.debug("Server exiting")
2494
logger.debug("Server received KeyboardInterrupt")
2495
logger.debug("Server exiting")
3680
2496
# Must run before the D-Bus bus name gets deregistered
3681
2497
cleanup()
3682
2498
3683
3684
def parse_test_args():
3685
# type: () -> argparse.Namespace
3686
parser = argparse.ArgumentParser(add_help=False)
3687
parser.add_argument("--check", action="store_true")
3688
parser.add_argument("--prefix", )
3689
args, unknown_args = parser.parse_known_args()
3690
if args.check:
3691
# Remove test options from sys.argv
3692
sys.argv[1:] = unknown_args
3693
return args
3694
3695
# Add all tests from doctest strings
3696
def load_tests(loader, tests, none):
3697
import doctest
3698
tests.addTests(doctest.DocTestSuite())
3699
return tests
3700
3701
if __name__ == "__main__":
3702
options = parse_test_args()
3703
try:
3704
if options.check:
3705
extra_test_prefix = options.prefix
3706
if extra_test_prefix is not None:
3707
if not (unittest.main(argv=[""], exit=False)
3708
.result.wasSuccessful()):
3709
sys.exit(1)
3710
class ExtraTestLoader(unittest.TestLoader):
3711
testMethodPrefix = extra_test_prefix
3712
# Call using ./scriptname --test [--verbose]
3713
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3714
else:
3715
unittest.main(argv=[""])
3716
else:
3717
main()
3718
finally:
3719
logging.shutdown()
3720
3721
# Local Variables:
3722
# run-tests:
3723
# (lambda (&optional extra)
3724
# (if (not (funcall run-tests-in-test-buffer default-directory
3725
# extra))
3726
# (funcall show-test-buffer-in-test-window)
3727
# (funcall remove-test-window)
3728
# (if extra (message "Extra tests run successfully!"))))
3729
# run-tests-in-test-buffer:
3730
# (lambda (dir &optional extra)
3731
# (with-current-buffer (get-buffer-create "*Test*")
3732
# (setq buffer-read-only nil
3733
# default-directory dir)
3734
# (erase-buffer)
3735
# (compilation-mode))
3736
# (let ((process-result
3737
# (let ((inhibit-read-only t))
3738
# (process-file-shell-command
3739
# (funcall get-command-line extra) nil "*Test*"))))
3740
# (and (numberp process-result)
3741
# (= process-result 0))))
3742
# get-command-line:
3743
# (lambda (&optional extra)
3744
# (let ((quoted-script
3745
# (shell-quote-argument (funcall get-script-name))))
3746
# (format
3747
# (concat "%s --check" (if extra " --prefix=atest" ""))
3748
# quoted-script)))
3749
# get-script-name:
3750
# (lambda ()
3751
# (if (fboundp 'file-local-name)
3752
# (file-local-name (buffer-file-name))
3753
# (or (file-remote-p (buffer-file-name) 'localname)
3754
# (buffer-file-name))))
3755
# remove-test-window:
3756
# (lambda ()
3757
# (let ((test-window (get-buffer-window "*Test*")))
3758
# (if test-window (delete-window test-window))))
3759
# show-test-buffer-in-test-window:
3760
# (lambda ()
3761
# (when (not (get-buffer-window-list "*Test*"))
3762
# (setq next-error-last-buffer (get-buffer "*Test*"))
3763
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3764
# (display-buffer-overriding-action
3765
# `((display-buffer-in-side-window) (side . ,side)
3766
# (window-height . fit-window-to-buffer)
3767
# (window-width . fit-window-to-buffer))))
3768
# (display-buffer "*Test*"))))
3769
# eval:
3770
# (progn
3771
# (let* ((run-extra-tests (lambda () (interactive)
3772
# (funcall run-tests t)))
3773
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3774
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3775
# (setq minor-mode-overriding-map-alist
3776
# (cons `(run-tests . ,outer-keymap)
3777
# minor-mode-overriding-map-alist)))
3778
# (add-hook 'after-save-hook run-tests 90 t))
3779
# End:
2499
2500
if __name__ == '__main__':
2501
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0