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 575
- compare with another revision
- download diff
- download tarball
- view history from revision 575
- Committer: Teddy Hogeborn
- Date: 2012-05-06 16:13:00 UTC
- Revision ID: teddy@recompile.se-20120506161300-43rls2rr4qub3zhw
* mandos: Use a class decorator instead of a metaclass to provide
alternate D-Bus interface names on D-Bus object attributes.
(alternate_dbus_interfaces): New class decorator.
(AlternateDBusNamesMetaclass, ClientDBusTransitional,
MandosDBusServiceTransitional): Removed; all users changed.
(ClientDbus, MandosDBusService): Use new "alternate_dbus_interfaces"
class decorator.
alternate D-Bus interface names on D-Bus object attributes.
(alternate_dbus_interfaces): New class decorator.
(AlternateDBusNamesMetaclass, ClientDBusTransitional,
MandosDBusServiceTransitional): Removed; all users changed.
(ClientDbus, MandosDBusService): Use new "alternate_dbus_interfaces"
class decorator.
- files added:
- initramfs-tools-hook-conf
- files removed:
- bugs.xml
- debian/tests
- debian/upstream
- dracut-module
- 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-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
16
#
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
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
68
import itertools
78
import collections
79
import codecs
80
import random
81
import shlex
82
69
83
70
import dbus
84
71
import dbus.service
85
import gi
86
from gi.repository import GLib
72
import gobject
73
import avahi
87
74
from dbus.mainloop.glib import DBusGMainLoop
88
75
import ctypes
89
76
import ctypes.util
90
77
import xml.dom.minidom
91
78
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:
79
import GnuPGInterface
80
81
try:
122
82
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
123
83
except AttributeError:
124
84
try:
125
# This is where SO_BINDTODEVICE was up to and including Python
126
# 2.6, and also 3.2:
127
85
from IN import SO_BINDTODEVICE
128
86
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"
87
SO_BINDTODEVICE = None
88
89
version = "1.5.3"
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
114
def initlogger(debug, 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
118
('Mandos [%(process)d]: %(levelname)s:'
119
' %(message)s'))
120
logger.addHandler(syslogger)
121
196
122
if debug:
197
123
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)
124
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
125
' [%(process)d]:'
126
' %(levelname)s:'
127
' %(message)s'))
128
logger.addHandler(console)
129
logger.setLevel(level)
204
130
205
131
206
132
class PGPError(Exception):
208
134
pass
209
135
210
136
211
class PGPEngine:
137
class PGPEngine(object):
212
138
"""A simple class for OpenPGP symmetric encryption & decryption"""
213
214
139
def __init__(self):
140
self.gnupg = GnuPGInterface.GnuPG()
215
141
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
142
self.gnupg = GnuPGInterface.GnuPG()
143
self.gnupg.options.meta_interactive = False
144
self.gnupg.options.homedir = self.tempdir
145
self.gnupg.options.extra_args.extend(['--force-mdc',
146
'--quiet',
147
'--no-use-agent'])
148
235
149
def __enter__(self):
236
150
return self
237
238
def __exit__(self, exc_type, exc_value, traceback):
151
152
def __exit__ (self, exc_type, exc_value, traceback):
239
153
self._cleanup()
240
154
return False
241
155
242
156
def __del__(self):
243
157
self._cleanup()
244
158
245
159
def _cleanup(self):
246
160
if self.tempdir is not None:
247
161
# Delete contents of tempdir
248
162
for root, dirs, files in os.walk(self.tempdir,
249
topdown=False):
163
topdown = False):
250
164
for filename in files:
251
165
os.remove(os.path.join(root, filename))
252
166
for dirname in dirs:
254
168
# Remove tempdir
255
169
os.rmdir(self.tempdir)
256
170
self.tempdir = None
257
171
258
172
def password_encode(self, password):
259
173
# Passphrase can not be empty and can not contain newlines or
260
174
# 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
175
return b"mandos" + binascii.hexlify(password)
176
269
177
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)
178
self.gnupg.passphrase = self.password_encode(password)
179
with open(os.devnull, "w") as devnull:
180
try:
181
proc = self.gnupg.run(['--symmetric'],
182
create_fhs=['stdin', 'stdout'],
183
attach_fhs={'stderr': devnull})
184
with contextlib.closing(proc.handles['stdin']) as f:
185
f.write(data)
186
with contextlib.closing(proc.handles['stdout']) as f:
187
ciphertext = f.read()
188
proc.wait()
189
except IOError as e:
190
raise PGPError(e)
191
self.gnupg.passphrase = None
285
192
return ciphertext
286
193
287
194
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)
195
self.gnupg.passphrase = self.password_encode(password)
196
with open(os.devnull, "w") as devnull:
197
try:
198
proc = self.gnupg.run(['--decrypt'],
199
create_fhs=['stdin', 'stdout'],
200
attach_fhs={'stderr': devnull})
201
with contextlib.closing(proc.handles['stdin']) as f:
202
f.write(data)
203
with contextlib.closing(proc.handles['stdout']) as f:
204
decrypted_plaintext = f.read()
205
proc.wait()
206
except IOError as e:
207
raise PGPError(e)
208
self.gnupg.passphrase = None
303
209
return decrypted_plaintext
304
210
305
211
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
332
212
class AvahiError(Exception):
333
213
def __init__(self, value, *args, **kwargs):
334
214
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
336
**kwargs)
337
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
338
218
339
219
class AvahiServiceError(AvahiError):
340
220
pass
341
221
342
343
222
class AvahiGroupError(AvahiError):
344
223
pass
345
224
346
225
347
class AvahiService:
226
class AvahiService(object):
348
227
"""An Avahi (Zeroconf) service.
349
228
350
229
Attributes:
351
230
interface: integer; avahi.IF_UNSPEC or an interface index.
352
231
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>
232
name: string; Example: 'Mandos'
233
type: string; Example: '_mandos._tcp'.
234
See <http://www.dns-sd.org/ServiceTypes.html>
356
235
port: integer; what port to announce
357
236
TXT: list of strings; TXT record for the service
358
237
domain: string; Domain to publish on, default to .local if empty.
364
243
server: D-Bus Server
365
244
bus: dbus.SystemBus()
366
245
"""
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):
246
247
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
248
servicetype = None, port = None, TXT = None,
249
domain = "", host = "", max_renames = 32768,
250
protocol = avahi.PROTO_UNSPEC, bus = None):
379
251
self.interface = interface
380
252
self.name = name
381
253
self.type = servicetype
390
262
self.server = None
391
263
self.bus = bus
392
264
self.entry_group_state_changed_match = None
393
394
def rename(self, remove=True):
265
266
def rename(self):
395
267
"""Derived from the Avahi example code"""
396
268
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)
269
logger.critical("No suitable Zeroconf service name found"
270
" after %i retries, exiting.",
271
self.rename_count)
400
272
raise AvahiServiceError("Too many renames")
401
self.name = str(
402
self.server.GetAlternativeServiceName(self.name))
273
self.name = unicode(self.server
274
.GetAlternativeServiceName(self.name))
275
logger.info("Changing Zeroconf service name to %r ...",
276
self.name)
277
self.remove()
278
try:
279
self.add()
280
except dbus.exceptions.DBusException as error:
281
logger.critical("D-Bus Exception", exc_info=error)
282
self.cleanup()
283
os._exit(1)
403
284
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
285
420
286
def remove(self):
421
287
"""Derived from the Avahi example code"""
422
288
if self.entry_group_state_changed_match is not None:
424
290
self.entry_group_state_changed_match = None
425
291
if self.group is not None:
426
292
self.group.Reset()
427
293
428
294
def add(self):
429
295
"""Derived from the Avahi example code"""
430
296
self.remove()
435
301
avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
302
self.entry_group_state_changed_match = (
437
303
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)
304
'StateChanged', self.entry_group_state_changed))
305
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
306
self.name, self.type)
441
307
self.group.AddService(
442
308
self.interface,
443
309
self.protocol,
447
313
dbus.UInt16(self.port),
448
314
avahi.string_array_to_txt_array(self.TXT))
449
315
self.group.Commit()
450
316
451
317
def entry_group_state_changed(self, state, error):
452
318
"""Derived from the Avahi example code"""
453
log.debug("Avahi entry group state change: %i", state)
454
319
logger.debug("Avahi entry group state change: %i", state)
320
455
321
if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
log.debug("Zeroconf service established.")
322
logger.debug("Zeroconf service established.")
457
323
elif state == avahi.ENTRY_GROUP_COLLISION:
458
log.info("Zeroconf service name collision.")
324
logger.info("Zeroconf service name collision.")
459
325
self.rename()
460
326
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
327
logger.critical("Avahi: Error in group state changed %s",
328
unicode(error))
329
raise AvahiGroupError("State changed: {0!s}"
330
.format(error))
331
465
332
def cleanup(self):
466
333
"""Derived from the Avahi example code"""
467
334
if self.group is not None:
472
339
pass
473
340
self.group = None
474
341
self.remove()
475
342
476
343
def server_state_changed(self, state, error=None):
477
344
"""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
}
345
logger.debug("Avahi server state change: %i", state)
346
bad_states = { avahi.SERVER_INVALID:
347
"Zeroconf server invalid",
348
avahi.SERVER_REGISTERING: None,
349
avahi.SERVER_COLLISION:
350
"Zeroconf server name collision",
351
avahi.SERVER_FAILURE:
352
"Zeroconf server failure" }
485
353
if state in bad_states:
486
354
if bad_states[state] is not None:
487
355
if error is None:
488
log.error(bad_states[state])
356
logger.error(bad_states[state])
489
357
else:
490
log.error(bad_states[state] + ": %r", error)
358
logger.error(bad_states[state] + ": %r", error)
491
359
self.cleanup()
492
360
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)
361
self.add()
504
362
else:
505
363
if error is None:
506
log.debug("Unknown state: %r", state)
364
logger.debug("Unknown state: %r", state)
507
365
else:
508
log.debug("Unknown state: %r: %r", state, error)
509
366
logger.debug("Unknown state: %r: %r", state, error)
367
510
368
def activate(self):
511
369
"""Derived from the Avahi example code"""
512
370
if self.server is None:
516
374
follow_name_owner_changes=True),
517
375
avahi.DBUS_INTERFACE_SERVER)
518
376
self.server.connect_to_signal("StateChanged",
519
self.server_state_changed)
377
self.server_state_changed)
520
378
self.server_state_changed(self.server.GetState())
521
379
522
523
380
class AvahiServiceToSyslog(AvahiService):
524
def rename(self, *args, **kwargs):
381
def rename(self):
525
382
"""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)))
383
ret = AvahiService.rename(self)
384
syslogger.setFormatter(logging.Formatter
385
('Mandos ({0}) [%(process)d]:'
386
' %(levelname)s: %(message)s'
387
.format(self.name)))
531
388
return ret
532
389
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:
390
def timedelta_to_milliseconds(td):
391
"Convert a datetime.timedelta() to milliseconds"
392
return ((td.days * 24 * 60 * 60 * 1000)
393
+ (td.seconds * 1000)
394
+ (td.microseconds // 1000))
395
396
class Client(object):
875
397
"""A representation of a client host served by this server.
876
398
877
399
Attributes:
878
approved: bool(); None if not yet approved/disapproved
400
approved: bool(); 'None' if not yet approved/disapproved
879
401
approval_delay: datetime.timedelta(); Time to wait for approval
880
402
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
403
checker: subprocess.Popen(); a running checker process used
404
to see if the client lives.
405
'None' if no process is running.
406
checker_callback_tag: a gobject event source tag, or None
885
407
checker_command: string; External command which is run to check
886
408
if client lives. %() expansions are done at
887
409
runtime with vars(self) as dict, so that for
888
410
instance %(name)s can be used in the command.
889
checker_initiator_tag: a GLib event source tag, or None
411
checker_initiator_tag: a gobject event source tag, or None
890
412
created: datetime.datetime(); (UTC) object creation
891
413
client_structure: Object describing what attributes a client has
892
414
and is used for storing the client at exit
893
415
current_checker_command: string; current running checker_command
894
disable_initiator_tag: a GLib event source tag, or None
416
disable_initiator_tag: a gobject event source tag, or None
895
417
enabled: bool()
896
418
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
419
uniquely identify the client
900
420
host: string; available for use by the checker command
901
421
interval: datetime.timedelta(); How often to start a new checker
902
422
last_approval_request: datetime.datetime(); (UTC) or None
904
424
last_checker_status: integer between 0 and 255 reflecting exit
905
425
status of last checker. -1 reflects crashed
906
426
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
909
427
last_enabled: datetime.datetime(); (UTC) or None
910
428
name: string; from the config file, used in log messages and
911
429
D-Bus identifiers
916
434
runtime_expansions: Allowed attributes for runtime expansion.
917
435
expires: datetime.datetime(); time (UTC) when a client will be
918
436
disabled, or None
919
server_settings: The server_settings dict from main()
920
437
"""
921
438
922
439
runtime_expansions = ("approval_delay", "approval_duration",
923
"created", "enabled", "expires", "key_id",
924
"fingerprint", "host", "interval",
925
"last_approval_request", "last_checked_ok",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
926
442
"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
443
client_defaults = { "timeout": "5m",
444
"extended_timeout": "15m",
445
"interval": "2m",
446
"checker": "fping -q -- %%(host)s",
447
"host": "",
448
"approval_delay": "0s",
449
"approval_duration": "1s",
450
"approved_by_default": "True",
451
"enabled": "True",
452
}
453
454
def timeout_milliseconds(self):
455
"Return the 'timeout' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.timeout)
457
458
def extended_timeout_milliseconds(self):
459
"Return the 'extended_timeout' attribute in milliseconds"
460
return timedelta_to_milliseconds(self.extended_timeout)
461
462
def interval_milliseconds(self):
463
"Return the 'interval' attribute in milliseconds"
464
return timedelta_to_milliseconds(self.interval)
465
466
def approval_delay_milliseconds(self):
467
return timedelta_to_milliseconds(self.approval_delay)
468
939
469
@staticmethod
940
470
def config_parser(config):
941
471
"""Construct a new dict of client settings of this form:
948
478
for client_name in config.sections():
949
479
section = dict(config.items(client_name))
950
480
client = settings[client_name] = {}
951
481
952
482
client["host"] = section["host"]
953
483
# Reformat values from string types to Python types
954
484
client["approved_by_default"] = config.getboolean(
955
485
client_name, "approved_by_default")
956
486
client["enabled"] = config.getboolean(client_name,
957
487
"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(" ", ""))
488
964
489
client["fingerprint"] = (section["fingerprint"].upper()
965
490
.replace(" ", ""))
966
491
if "secret" in section:
967
client["secret"] = codecs.decode(section["secret"]
968
.encode("utf-8"),
969
"base64")
492
client["secret"] = section["secret"].decode("base64")
970
493
elif "secfile" in section:
971
494
with open(os.path.expanduser(os.path.expandvars
972
495
(section["secfile"])),
973
496
"rb") as secfile:
974
497
client["secret"] = secfile.read()
975
498
else:
976
raise TypeError("No secret or secfile for section {}"
499
raise TypeError("No secret or secfile for section {0}"
977
500
.format(section))
978
501
client["timeout"] = string_to_delta(section["timeout"])
979
502
client["extended_timeout"] = string_to_delta(
987
510
client["last_approval_request"] = None
988
511
client["last_checked_ok"] = None
989
512
client["last_checker_status"] = -2
990
513
991
514
return settings
992
993
def __init__(self, settings, name=None, server_settings=None):
515
516
def __init__(self, settings, name = None):
994
517
self.name = name
995
if server_settings is None:
996
server_settings = {}
997
self.server_settings = server_settings
998
518
# adding all client settings
999
for setting, value in settings.items():
519
for setting, value in settings.iteritems():
1000
520
setattr(self, setting, value)
1001
521
1002
522
if self.enabled:
1003
523
if not hasattr(self, "last_enabled"):
1004
524
self.last_enabled = datetime.datetime.utcnow()
1008
528
else:
1009
529
self.last_enabled = None
1010
530
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)
531
532
logger.debug("Creating client %r", self.name)
533
# Uppercase and remove spaces from fingerprint for later
534
# comparison purposes with return value from the fingerprint()
535
# function
536
logger.debug(" Fingerprint: %s", self.fingerprint)
1015
537
self.created = settings.get("created",
1016
538
datetime.datetime.utcnow())
1017
539
1018
540
# attributes specific for this server instance
1019
541
self.checker = None
1020
542
self.checker_initiator_tag = None
1023
545
self.current_checker_command = None
1024
546
self.approved = None
1025
547
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()
548
self.changedstate = (multiprocessing_manager
549
.Condition(multiprocessing_manager
550
.Lock()))
551
self.client_structure = [attr for attr in
552
self.__dict__.iterkeys()
1030
553
if not attr.startswith("_")]
1031
554
self.client_structure.append("client_structure")
1032
1033
for name, t in inspect.getmembers(
1034
type(self), lambda obj: isinstance(obj, property)):
555
556
for name, t in inspect.getmembers(type(self),
557
lambda obj:
558
isinstance(obj,
559
property)):
1035
560
if not name.startswith("_"):
1036
561
self.client_structure.append(name)
1037
562
1038
563
# Send notice to process children that client state has changed
1039
564
def send_changedstate(self):
1040
565
with self.changedstate:
1041
566
self.changedstate.notify_all()
1042
567
1043
568
def enable(self):
1044
569
"""Start this client's checker and timeout hooks"""
1045
570
if getattr(self, "enabled", False):
1046
571
# Already enabled
1047
572
return
573
self.send_changedstate()
574
self.expires = datetime.datetime.utcnow() + self.timeout
1048
575
self.enabled = True
1049
576
self.last_enabled = datetime.datetime.utcnow()
1050
577
self.init_checker()
1051
self.send_changedstate()
1052
578
1053
579
def disable(self, quiet=True):
1054
580
"""Disable this client."""
1055
581
if not getattr(self, "enabled", False):
1056
582
return False
1057
583
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)
584
self.send_changedstate()
585
if not quiet:
586
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
588
gobject.source_remove(self.disable_initiator_tag)
1061
589
self.disable_initiator_tag = None
1062
590
self.expires = None
1063
if getattr(self, "checker_initiator_tag", None) is not None:
1064
GLib.source_remove(self.checker_initiator_tag)
591
if getattr(self, "checker_initiator_tag", False):
592
gobject.source_remove(self.checker_initiator_tag)
1065
593
self.checker_initiator_tag = None
1066
594
self.stop_checker()
1067
595
self.enabled = False
1068
if not quiet:
1069
self.send_changedstate()
1070
# Do not run this again if called by a GLib.timeout_add
596
# Do not run this again if called by a gobject.timeout_add
1071
597
return False
1072
598
1073
599
def __del__(self):
1074
600
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):
601
602
def init_checker(self):
603
# Schedule a new checker to be started an 'interval' from now,
604
# and every interval from then on.
605
self.checker_initiator_tag = (gobject.timeout_add
606
(self.interval_milliseconds(),
607
self.start_checker))
608
# Schedule a disable() when 'timeout' has passed
609
self.disable_initiator_tag = (gobject.timeout_add
610
(self.timeout_milliseconds(),
611
self.disable))
612
# Also start a new checker *right now*.
613
self.start_checker()
614
615
def checker_callback(self, pid, condition, command):
1108
616
"""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
617
self.checker_callback_tag = None
1115
618
self.checker = None
1116
1117
if returncode >= 0:
1118
self.last_checker_status = returncode
1119
self.last_checker_signal = None
619
if os.WIFEXITED(condition):
620
self.last_checker_status = os.WEXITSTATUS(condition)
1120
621
if self.last_checker_status == 0:
1121
log.info("Checker for %(name)s succeeded", vars(self))
622
logger.info("Checker for %(name)s succeeded",
623
vars(self))
1122
624
self.checked_ok()
1123
625
else:
1124
log.info("Checker for %(name)s failed", vars(self))
626
logger.info("Checker for %(name)s failed",
627
vars(self))
1125
628
else:
1126
629
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
630
logger.warning("Checker for %(name)s crashed?",
631
vars(self))
632
1131
633
def checked_ok(self):
1132
634
"""Assert that the client has been seen, alive and well."""
1133
635
self.last_checked_ok = datetime.datetime.utcnow()
1134
636
self.last_checker_status = 0
1135
self.last_checker_signal = None
1136
637
self.bump_timeout()
1137
638
1138
639
def bump_timeout(self, timeout=None):
1139
640
"""Bump up the timeout for this client."""
1140
641
if timeout is None:
1141
642
timeout = self.timeout
1142
643
if self.disable_initiator_tag is not None:
1143
GLib.source_remove(self.disable_initiator_tag)
1144
self.disable_initiator_tag = None
644
gobject.source_remove(self.disable_initiator_tag)
1145
645
if getattr(self, "enabled", False):
1146
self.disable_initiator_tag = GLib.timeout_add(
1147
int(timeout.total_seconds() * 1000), self.disable)
646
self.disable_initiator_tag = (gobject.timeout_add
647
(timedelta_to_milliseconds
648
(timeout), self.disable))
1148
649
self.expires = datetime.datetime.utcnow() + timeout
1149
650
1150
651
def need_approval(self):
1151
652
self.last_approval_request = datetime.datetime.utcnow()
1152
1153
def start_checker(self, start_was_randomized=False):
653
654
def start_checker(self):
1154
655
"""Start a new checker subprocess if one is not running.
1155
656
1156
657
If a checker already exists, leave it running and do
1157
658
nothing."""
1158
659
# 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
660
# did that, then if a checker (for some reason) started
661
# running slowly and taking more than 'interval' time, the
662
# client would inevitably timeout, since no checker would get
663
# a chance to run to completion. If we instead leave running
1163
664
# checkers alone, the checker would have to take more time
1164
665
# than 'timeout' for the client to be disabled, which is as it
1165
666
# 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
667
668
# If a checker exists, make sure it is not a zombie
669
try:
670
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
except (AttributeError, OSError) as error:
672
if (isinstance(error, OSError)
673
and error.errno != errno.ECHILD):
674
raise error
675
else:
676
if pid:
677
logger.warning("Checker was a zombie")
678
gobject.source_remove(self.checker_callback_tag)
679
self.checker_callback(pid, status,
680
self.current_checker_command)
1171
681
# Start a new checker if needed
1172
682
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
683
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
684
# In case checker_command has exactly one % operator
685
command = self.checker_command % self.host
686
except TypeError:
687
# Escape attributes for the shell
688
escaped_attrs = dict(
689
(attr,
690
re.escape(unicode(str(getattr(self, attr, "")),
691
errors=
692
'replace')))
693
for attr in
694
self.runtime_expansions)
695
696
try:
697
command = self.checker_command % escaped_attrs
698
except TypeError as error:
699
logger.error('Could not format string "%s"',
700
self.checker_command, exc_info=error)
701
return True # Try again later
1183
702
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
703
try:
704
logger.info("Starting checker %r for %s",
705
command, self.name)
706
# We don't need to redirect stdout and stderr, since
707
# in normal mode, that is already done by daemon(),
708
# and in debug mode we don't want to. (Stdin is
709
# always replaced by /dev/null.)
710
self.checker = subprocess.Popen(command,
711
close_fds=True,
712
shell=True, cwd="/")
713
self.checker_callback_tag = (gobject.child_watch_add
714
(self.checker.pid,
715
self.checker_callback,
716
data=command))
717
# The checker may have completed before the gobject
718
# watch was added. Check for this.
719
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
720
if pid:
721
gobject.source_remove(self.checker_callback_tag)
722
self.checker_callback(pid, status, command)
723
except OSError as error:
724
logger.error("Failed to start subprocess",
725
exc_info=error)
726
# Re-run this periodically if run by gobject.timeout_add
1221
727
return True
1222
728
1223
729
def stop_checker(self):
1224
730
"""Force the checker process, if any, to stop."""
1225
731
if self.checker_callback_tag:
1226
GLib.source_remove(self.checker_callback_tag)
732
gobject.source_remove(self.checker_callback_tag)
1227
733
self.checker_callback_tag = None
1228
734
if getattr(self, "checker", None) is None:
1229
735
return
1230
log.debug("Stopping checker for %(name)s", vars(self))
1231
self.checker.terminate()
736
logger.debug("Stopping checker for %(name)s", vars(self))
737
try:
738
self.checker.terminate()
739
#time.sleep(0.5)
740
#if self.checker.poll() is None:
741
# self.checker.kill()
742
except OSError as error:
743
if error.errno != errno.ESRCH: # No such process
744
raise
1232
745
self.checker = None
1233
746
1234
747
1235
def dbus_service_property(dbus_interface,
1236
signature="v",
1237
access="readwrite",
1238
byte_arrays=False):
748
def dbus_service_property(dbus_interface, signature="v",
749
access="readwrite", byte_arrays=False):
1239
750
"""Decorators for marking methods of a DBusObjectWithProperties to
1240
751
become properties on the D-Bus.
1241
752
1242
753
The decorated method will be called with no arguments by "Get"
1243
754
and with one argument by "Set".
1244
755
1245
756
The parameters, where they are supported, are the same as
1246
757
dbus.service.method, except there is only "signature", since the
1247
758
type from Get() and the type sent to Set() is the same.
1250
761
# "Set" method, so we fail early here:
1251
762
if byte_arrays and signature != "ay":
1252
763
raise ValueError("Byte arrays not supported for non-'ay'"
1253
" signature {!r}".format(signature))
1254
764
" signature {0!r}".format(signature))
1255
765
def decorator(func):
1256
766
func._dbus_is_property = True
1257
767
func._dbus_interface = dbus_interface
1260
770
func._dbus_name = func.__name__
1261
771
if func._dbus_name.endswith("_dbus_property"):
1262
772
func._dbus_name = func._dbus_name[:-14]
1263
func._dbus_get_args_options = {"byte_arrays": byte_arrays}
773
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1264
774
return func
1265
1266
775
return decorator
1267
776
1268
777
1269
778
def dbus_interface_annotations(dbus_interface):
1270
779
"""Decorator for marking functions returning interface annotations
1271
780
1272
781
Usage:
1273
782
1274
783
@dbus_interface_annotations("org.example.Interface")
1275
784
def _foo(self): # Function name does not matter
1276
785
return {"org.freedesktop.DBus.Deprecated": "true",
1277
786
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1278
787
"false"}
1279
788
"""
1280
1281
789
def decorator(func):
1282
790
func._dbus_is_interface = True
1283
791
func._dbus_interface = dbus_interface
1284
792
func._dbus_name = dbus_interface
1285
793
return func
1286
1287
794
return decorator
1288
795
1289
796
1290
797
def dbus_annotations(annotations):
1291
798
"""Decorator to annotate D-Bus methods, signals or properties
1292
799
Usage:
1293
1294
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1295
"org.freedesktop.DBus.Property."
1296
"EmitsChangedSignal": "false"})
800
1297
801
@dbus_service_property("org.example.Interface", signature="b",
1298
802
access="r")
803
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
804
"org.freedesktop.DBus.Property."
805
"EmitsChangedSignal": "false"})
1299
806
def Property_dbus_property(self):
1300
807
return dbus.Boolean(False)
1301
1302
See also the DBusObjectWithAnnotations class.
1303
808
"""
1304
1305
809
def decorator(func):
1306
810
func._dbus_annotations = annotations
1307
811
return func
1308
1309
812
return decorator
1310
813
1311
814
1312
815
class DBusPropertyException(dbus.exceptions.DBusException):
1313
816
"""A base class for D-Bus property-related exceptions
1314
817
"""
1315
pass
818
def __unicode__(self):
819
return unicode(str(self))
1316
820
1317
821
1318
822
class DBusPropertyAccessException(DBusPropertyException):
1327
831
pass
1328
832
1329
833
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.
834
class DBusObjectWithProperties(dbus.service.Object):
835
"""A D-Bus object with properties.
836
837
Classes inheriting from this can use the dbus_service_property
838
decorator to expose methods as D-Bus properties. It exposes the
839
standard Get(), Set(), and GetAll() methods on the D-Bus.
1335
840
"""
1336
841
1337
842
@staticmethod
1338
843
def _is_dbus_thing(thing):
1339
844
"""Returns a function testing if an attribute is a D-Bus thing
1340
845
1341
846
If called like _is_dbus_thing("method") it returns a function
1342
847
suitable for use as predicate to inspect.getmembers().
1343
848
"""
1344
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
849
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1345
850
False)
1346
851
1347
852
def _get_all_dbus_things(self, thing):
1348
853
"""Returns a generator of (name, attribute) pairs
1349
854
"""
1350
return ((getattr(athing.__get__(self), "_dbus_name", name),
855
return ((getattr(athing.__get__(self), "_dbus_name",
856
name),
1351
857
athing.__get__(self))
1352
858
for cls in self.__class__.__mro__
1353
859
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):
1420
"""A D-Bus object with properties.
1421
1422
Classes inheriting from this can use the dbus_service_property
1423
decorator to expose methods as D-Bus properties. It exposes the
1424
standard Get(), Set(), and GetAll() methods on the D-Bus.
1425
"""
1426
860
inspect.getmembers(cls,
861
self._is_dbus_thing(thing)))
862
1427
863
def _get_dbus_property(self, interface_name, property_name):
1428
864
"""Returns a bound method if one exists which is a D-Bus
1429
865
property with the specified name and interface.
1430
866
"""
1431
for cls in self.__class__.__mro__:
1432
for name, value in inspect.getmembers(
1433
cls, self._is_dbus_thing("property")):
867
for cls in self.__class__.__mro__:
868
for name, value in (inspect.getmembers
869
(cls,
870
self._is_dbus_thing("property"))):
1434
871
if (value._dbus_name == property_name
1435
872
and value._dbus_interface == interface_name):
1436
873
return value.__get__(self)
1437
874
1438
875
# 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",
876
raise DBusPropertyNotFound(self.dbus_object_path + ":"
877
+ interface_name + "."
878
+ property_name)
879
880
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1453
881
out_signature="v")
1454
882
def Get(self, interface_name, property_name):
1455
883
"""Standard D-Bus property Get() method, see D-Bus standard.
1461
889
if not hasattr(value, "variant_level"):
1462
890
return value
1463
891
return type(value)(value, variant_level=value.variant_level+1)
1464
892
1465
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1466
894
def Set(self, interface_name, property_name, value):
1467
895
"""Standard D-Bus property Set() method, see D-Bus standard.
1473
901
# The byte_arrays option is not supported yet on
1474
902
# signatures other than "ay".
1475
903
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))
904
raise ValueError
905
value = dbus.ByteArray(b''.join(chr(byte)
906
for byte in value))
1480
907
prop(value)
1481
1482
@dbus.service.method(dbus.PROPERTIES_IFACE,
1483
in_signature="s",
908
909
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1484
910
out_signature="a{sv}")
1485
911
def GetAll(self, interface_name):
1486
912
"""Standard D-Bus property GetAll() method, see D-Bus
1487
913
standard.
1488
914
1489
915
Note: Will not include properties with access="write".
1490
916
"""
1491
917
properties = {}
1501
927
if not hasattr(value, "variant_level"):
1502
928
properties[name] = value
1503
929
continue
1504
properties[name] = type(value)(
1505
value, variant_level=value.variant_level + 1)
930
properties[name] = type(value)(value, variant_level=
931
value.variant_level+1)
1506
932
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
933
1516
934
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1517
935
out_signature="s",
1518
path_keyword="object_path",
1519
connection_keyword="connection")
936
path_keyword='object_path',
937
connection_keyword='connection')
1520
938
def Introspect(self, object_path, connection):
1521
939
"""Overloading of standard D-Bus method.
1522
940
1523
941
Inserts property tags and interface annotation tags.
1524
942
"""
1525
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1526
object_path,
1527
connection)
943
xmlstring = dbus.service.Object.Introspect(self, object_path,
944
connection)
1528
945
try:
1529
946
document = xml.dom.minidom.parseString(xmlstring)
1530
1531
947
def make_tag(document, name, prop):
1532
948
e = document.createElement("property")
1533
949
e.setAttribute("name", name)
1534
950
e.setAttribute("type", prop._dbus_signature)
1535
951
e.setAttribute("access", prop._dbus_access)
1536
952
return e
1537
1538
953
for if_tag in document.getElementsByTagName("interface"):
1539
954
# Add property tags
1540
955
for tag in (make_tag(document, name, prop)
1543
958
if prop._dbus_interface
1544
959
== if_tag.getAttribute("name")):
1545
960
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)
961
# Add annotation tags
962
for typ in ("method", "signal", "property"):
963
for tag in if_tag.getElementsByTagName(typ):
964
annots = dict()
965
for name, prop in (self.
966
_get_all_dbus_things(typ)):
967
if (name == tag.getAttribute("name")
968
and prop._dbus_interface
969
== if_tag.getAttribute("name")):
970
annots.update(getattr
971
(prop,
972
"_dbus_annotations",
973
{}))
974
for name, value in annots.iteritems():
975
ann_tag = document.createElement(
976
"annotation")
977
ann_tag.setAttribute("name", name)
978
ann_tag.setAttribute("value", value)
979
tag.appendChild(ann_tag)
980
# Add interface annotation tags
981
for annotation, value in dict(
982
itertools.chain(
983
*(annotations().iteritems()
984
for name, annotations in
985
self._get_all_dbus_things("interface")
986
if name == if_tag.getAttribute("name")
987
))).iteritems():
988
ann_tag = document.createElement("annotation")
989
ann_tag.setAttribute("name", annotation)
990
ann_tag.setAttribute("value", value)
991
if_tag.appendChild(ann_tag)
1562
992
# Add the names to the return values for the
1563
993
# "org.freedesktop.DBus.Properties" methods
1564
994
if (if_tag.getAttribute("name")
1578
1008
document.unlink()
1579
1009
except (AttributeError, xml.dom.DOMException,
1580
1010
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):
1011
logger.error("Failed to override Introspection method",
1012
exc_info=error)
1013
return xmlstring
1014
1015
1016
def datetime_to_dbus (dt, variant_level=0):
1658
1017
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1659
1018
if dt is None:
1660
return dbus.String("", variant_level=variant_level)
1661
return dbus.String(dt.isoformat(), variant_level=variant_level)
1019
return dbus.String("", variant_level = variant_level)
1020
return dbus.String(dt.isoformat(),
1021
variant_level=variant_level)
1662
1022
1663
1023
1664
1024
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1666
1026
dbus.service.Object, it will add alternate D-Bus attributes with
1667
1027
interface names according to the "alt_interface_names" mapping.
1668
1028
Usage:
1669
1670
@alternate_dbus_interfaces({"org.example.Interface":
1671
"net.example.AlternateInterface"})
1029
1030
@alternate_dbus_names({"org.example.Interface":
1031
"net.example.AlternateInterface"})
1672
1032
class SampleDBusObject(dbus.service.Object):
1673
1033
@dbus.service.method("org.example.Interface")
1674
1034
def SampleDBusMethod():
1675
1035
pass
1676
1036
1677
1037
The above "SampleDBusMethod" on "SampleDBusObject" will be
1678
1038
reachable via two interfaces: "org.example.Interface" and
1679
1039
"net.example.AlternateInterface", the latter of which will have
1680
1040
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1681
1041
"true", unless "deprecate" is passed with a False value.
1682
1042
1683
1043
This works for methods and signals, and also for D-Bus properties
1684
1044
(from DBusObjectWithProperties) and interfaces (from the
1685
1045
dbus_interface_annotations decorator).
1686
1046
"""
1687
1688
1047
def wrapper(cls):
1689
1048
for orig_interface_name, alt_interface_name in (
1690
alt_interface_names.items()):
1049
alt_interface_names.iteritems()):
1691
1050
attr = {}
1692
1051
interface_names = set()
1693
1052
# Go though all attributes of the class
1695
1054
# Ignore non-D-Bus attributes, and D-Bus attributes
1696
1055
# with the wrong interface name
1697
1056
if (not hasattr(attribute, "_dbus_interface")
1698
or not attribute._dbus_interface.startswith(
1699
orig_interface_name)):
1057
or not attribute._dbus_interface
1058
.startswith(orig_interface_name)):
1700
1059
continue
1701
1060
# Create an alternate D-Bus interface name based on
1702
1061
# the current name
1703
alt_interface = attribute._dbus_interface.replace(
1704
orig_interface_name, alt_interface_name)
1062
alt_interface = (attribute._dbus_interface
1063
.replace(orig_interface_name,
1064
alt_interface_name))
1705
1065
interface_names.add(alt_interface)
1706
1066
# Is this a D-Bus signal?
1707
1067
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(
1068
# Extract the original non-method function by
1069
# black magic
1070
nonmethod_func = (dict(
1712
1071
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)
1072
attribute.__closure__))["func"]
1073
.cell_contents)
1720
1074
# Create a new, but exactly alike, function
1721
1075
# object, and decorate it to be a new D-Bus signal
1722
1076
# 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))
1077
new_function = (dbus.service.signal
1078
(alt_interface,
1079
attribute._dbus_signature)
1080
(types.FunctionType(
1081
nonmethod_func.func_code,
1082
nonmethod_func.func_globals,
1083
nonmethod_func.func_name,
1084
nonmethod_func.func_defaults,
1085
nonmethod_func.func_closure)))
1727
1086
# Copy annotations, if any
1728
1087
try:
1729
new_function._dbus_annotations = dict(
1730
attribute._dbus_annotations)
1088
new_function._dbus_annotations = (
1089
dict(attribute._dbus_annotations))
1731
1090
except AttributeError:
1732
1091
pass
1733
1734
1092
# Define a creator of a function to call both the
1735
1093
# original and alternate functions, so both the
1736
1094
# original and alternate signals gets sent when
1739
1097
"""This function is a scope container to pass
1740
1098
func1 and func2 to the "call_both" function
1741
1099
outside of its arguments"""
1742
1743
@functools.wraps(func2)
1744
1100
def call_both(*args, **kwargs):
1745
1101
"""This function will emit two D-Bus
1746
1102
signals by calling func1 and func2"""
1747
1103
func1(*args, **kwargs)
1748
1104
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
1105
return call_both
1756
1106
# Create the "call_both" function and add it to
1757
1107
# the class
1762
1112
# object. Decorate it to be a new D-Bus method
1763
1113
# with the alternate D-Bus interface name. Add it
1764
1114
# 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)))
1115
attr[attrname] = (dbus.service.method
1116
(alt_interface,
1117
attribute._dbus_in_signature,
1118
attribute._dbus_out_signature)
1119
(types.FunctionType
1120
(attribute.func_code,
1121
attribute.func_globals,
1122
attribute.func_name,
1123
attribute.func_defaults,
1124
attribute.func_closure)))
1771
1125
# Copy annotations, if any
1772
1126
try:
1773
attr[attrname]._dbus_annotations = dict(
1774
attribute._dbus_annotations)
1127
attr[attrname]._dbus_annotations = (
1128
dict(attribute._dbus_annotations))
1775
1129
except AttributeError:
1776
1130
pass
1777
1131
# Is this a D-Bus property?
1780
1134
# object, and decorate it to be a new D-Bus
1781
1135
# property with the alternate D-Bus interface
1782
1136
# 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)))
1137
attr[attrname] = (dbus_service_property
1138
(alt_interface,
1139
attribute._dbus_signature,
1140
attribute._dbus_access,
1141
attribute
1142
._dbus_get_args_options
1143
["byte_arrays"])
1144
(types.FunctionType
1145
(attribute.func_code,
1146
attribute.func_globals,
1147
attribute.func_name,
1148
attribute.func_defaults,
1149
attribute.func_closure)))
1789
1150
# Copy annotations, if any
1790
1151
try:
1791
attr[attrname]._dbus_annotations = dict(
1792
attribute._dbus_annotations)
1152
attr[attrname]._dbus_annotations = (
1153
dict(attribute._dbus_annotations))
1793
1154
except AttributeError:
1794
1155
pass
1795
1156
# Is this a D-Bus interface?
1798
1159
# object. Decorate it to be a new D-Bus interface
1799
1160
# with the alternate D-Bus interface name. Add it
1800
1161
# to the class.
1801
attr[attrname] = (
1802
dbus_interface_annotations(alt_interface)
1803
(copy_function(attribute)))
1162
attr[attrname] = (dbus_interface_annotations
1163
(alt_interface)
1164
(types.FunctionType
1165
(attribute.func_code,
1166
attribute.func_globals,
1167
attribute.func_name,
1168
attribute.func_defaults,
1169
attribute.func_closure)))
1804
1170
if deprecate:
1805
1171
# Deprecate all alternate interfaces
1806
iname = "_AlternateDBusNames_interface_annotation{}"
1172
iname="_AlternateDBusNames_interface_annotation{0}"
1807
1173
for interface_name in interface_names:
1808
1809
1174
@dbus_interface_annotations(interface_name)
1810
1175
def func(self):
1811
return {"org.freedesktop.DBus.Deprecated":
1812
"true"}
1176
return { "org.freedesktop.DBus.Deprecated":
1177
"true" }
1813
1178
# Find an unused name
1814
1179
for aname in (iname.format(i)
1815
1180
for i in itertools.count()):
1819
1184
if interface_names:
1820
1185
# Replace the class with a new subclass of it with
1821
1186
# 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)
1187
cls = type(b"{0}Alternate".format(cls.__name__),
1188
(cls,), attr)
1828
1189
return cls
1829
1830
1190
return wrapper
1831
1191
1832
1192
1833
1193
@alternate_dbus_interfaces({"se.recompile.Mandos":
1834
"se.bsnet.fukt.Mandos"})
1194
"se.bsnet.fukt.Mandos"})
1835
1195
class ClientDBus(Client, DBusObjectWithProperties):
1836
1196
"""A Client class using D-Bus
1837
1197
1838
1198
Attributes:
1839
1199
dbus_object_path: dbus.ObjectPath
1840
1200
bus: dbus.SystemBus()
1841
1201
"""
1842
1202
1843
1203
runtime_expansions = (Client.runtime_expansions
1844
+ ("dbus_object_path", ))
1845
1846
_interface = "se.recompile.Mandos.Client"
1847
1204
+ ("dbus_object_path",))
1205
1848
1206
# dbus.service.Object doesn't use super(), so we can't either.
1849
1850
def __init__(self, bus=None, *args, **kwargs):
1207
1208
def __init__(self, bus = None, *args, **kwargs):
1851
1209
self.bus = bus
1852
1210
Client.__init__(self, *args, **kwargs)
1853
1211
# Only now, when this client is initialized, can it show up on
1854
1212
# the D-Bus
1855
client_object_name = str(self.name).translate(
1213
client_object_name = unicode(self.name).translate(
1856
1214
{ord("."): ord("_"),
1857
1215
ord("-"): ord("_")})
1858
self.dbus_object_path = dbus.ObjectPath(
1859
"/clients/" + client_object_name)
1216
self.dbus_object_path = (dbus.ObjectPath
1217
("/clients/" + client_object_name))
1860
1218
DBusObjectWithProperties.__init__(self, self.bus,
1861
1219
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):
1220
1221
def notifychangeproperty(transform_func,
1222
dbus_name, type_func=lambda x: x,
1223
variant_level=1):
1868
1224
""" Modify a variable so that it's a property which announces
1869
1225
its changes to DBus.
1870
1226
1871
1227
transform_fun: Function that takes a value and a variant_level
1872
1228
and transforms it to a D-Bus type.
1873
1229
dbus_name: D-Bus name of the variable
1875
1231
to the D-Bus. Default: no transform
1876
1232
variant_level: D-Bus variant level. Default: 1
1877
1233
"""
1878
attrname = "_{}".format(dbus_name)
1879
1234
attrname = "_{0}".format(dbus_name)
1880
1235
def setter(self, value):
1881
1236
if hasattr(self, "dbus_object_path"):
1882
1237
if (not hasattr(self, attrname) or
1883
1238
type_func(getattr(self, attrname, None))
1884
1239
!= 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())
1240
dbus_value = transform_func(type_func(value),
1241
variant_level
1242
=variant_level)
1243
self.PropertyChanged(dbus.String(dbus_name),
1244
dbus_value)
1900
1245
setattr(self, attrname, value)
1901
1246
1902
1247
return property(lambda self: getattr(self, attrname), setter)
1903
1248
1904
1249
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1905
1250
approvals_pending = notifychangeproperty(dbus.Boolean,
1906
1251
"ApprovalPending",
1907
type_func=bool)
1252
type_func = bool)
1908
1253
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1909
1254
last_enabled = notifychangeproperty(datetime_to_dbus,
1910
1255
"LastEnabled")
1911
checker = notifychangeproperty(
1912
dbus.Boolean, "CheckerRunning",
1913
type_func=lambda checker: checker is not None)
1256
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1257
type_func = lambda checker:
1258
checker is not None)
1914
1259
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1915
1260
"LastCheckedOK")
1916
1261
last_checker_status = notifychangeproperty(dbus.Int16,
1919
1264
datetime_to_dbus, "LastApprovalRequest")
1920
1265
approved_by_default = notifychangeproperty(dbus.Boolean,
1921
1266
"ApprovedByDefault")
1922
approval_delay = notifychangeproperty(
1923
dbus.UInt64, "ApprovalDelay",
1924
type_func=lambda td: td.total_seconds() * 1000)
1267
approval_delay = notifychangeproperty(dbus.UInt64,
1268
"ApprovalDelay",
1269
type_func =
1270
timedelta_to_milliseconds)
1925
1271
approval_duration = notifychangeproperty(
1926
1272
dbus.UInt64, "ApprovalDuration",
1927
type_func=lambda td: td.total_seconds() * 1000)
1273
type_func = timedelta_to_milliseconds)
1928
1274
host = notifychangeproperty(dbus.String, "Host")
1929
timeout = notifychangeproperty(
1930
dbus.UInt64, "Timeout",
1931
type_func=lambda td: td.total_seconds() * 1000)
1275
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1276
type_func =
1277
timedelta_to_milliseconds)
1932
1278
extended_timeout = notifychangeproperty(
1933
1279
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)
1280
type_func = timedelta_to_milliseconds)
1281
interval = notifychangeproperty(dbus.UInt64,
1282
"Interval",
1283
type_func =
1284
timedelta_to_milliseconds)
1938
1285
checker_command = notifychangeproperty(dbus.String, "Checker")
1939
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1940
invalidate_only=True)
1941
1286
1942
1287
del notifychangeproperty
1943
1288
1944
1289
def __del__(self, *args, **kwargs):
1945
1290
try:
1946
1291
self.remove_from_connection()
1949
1294
if hasattr(DBusObjectWithProperties, "__del__"):
1950
1295
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1951
1296
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:
1297
1298
def checker_callback(self, pid, condition, command,
1299
*args, **kwargs):
1300
self.checker_callback_tag = None
1301
self.checker = None
1302
if os.WIFEXITED(condition):
1303
exitstatus = os.WEXITSTATUS(condition)
1960
1304
# Emit D-Bus signal
1961
1305
self.CheckerCompleted(dbus.Int16(exitstatus),
1962
# This is specific to GNU libC
1963
dbus.Int64(exitstatus << 8),
1306
dbus.Int64(condition),
1964
1307
dbus.String(command))
1965
1308
else:
1966
1309
# Emit D-Bus signal
1967
1310
self.CheckerCompleted(dbus.Int16(-1),
1968
dbus.Int64(
1969
# This is specific to GNU libC
1970
(exitstatus << 8)
1971
| self.last_checker_signal),
1311
dbus.Int64(condition),
1972
1312
dbus.String(command))
1973
return ret
1974
1313
1314
return Client.checker_callback(self, pid, condition, command,
1315
*args, **kwargs)
1316
1975
1317
def start_checker(self, *args, **kwargs):
1976
old_checker_pid = getattr(self.checker, "pid", None)
1318
old_checker = self.checker
1319
if self.checker is not None:
1320
old_checker_pid = self.checker.pid
1321
else:
1322
old_checker_pid = None
1977
1323
r = Client.start_checker(self, *args, **kwargs)
1978
1324
# Only if new checker process was started
1979
1325
if (self.checker is not None
1981
1327
# Emit D-Bus signal
1982
1328
self.CheckerStarted(self.current_checker_command)
1983
1329
return r
1984
1330
1985
1331
def _reset_approved(self):
1986
1332
self.approved = None
1987
1333
return False
1988
1334
1989
1335
def approve(self, value=True):
1336
self.send_changedstate()
1990
1337
self.approved = value
1991
GLib.timeout_add(int(self.approval_duration.total_seconds()
1992
* 1000), self._reset_approved)
1993
self.send_changedstate()
1994
1995
# D-Bus methods, signals & properties
1996
1997
# Interfaces
1998
1999
# Signals
2000
1338
gobject.timeout_add(timedelta_to_milliseconds
1339
(self.approval_duration),
1340
self._reset_approved)
1341
1342
## D-Bus methods, signals & properties
1343
_interface = "se.recompile.Mandos.Client"
1344
1345
## Interfaces
1346
1347
@dbus_interface_annotations(_interface)
1348
def _foo(self):
1349
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1350
"false"}
1351
1352
## Signals
1353
2001
1354
# CheckerCompleted - signal
2002
1355
@dbus.service.signal(_interface, signature="nxs")
2003
1356
def CheckerCompleted(self, exitcode, waitstatus, command):
2004
1357
"D-Bus signal"
2005
1358
pass
2006
1359
2007
1360
# CheckerStarted - signal
2008
1361
@dbus.service.signal(_interface, signature="s")
2009
1362
def CheckerStarted(self, command):
2010
1363
"D-Bus signal"
2011
1364
pass
2012
1365
2013
1366
# PropertyChanged - signal
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2015
1367
@dbus.service.signal(_interface, signature="sv")
2016
1368
def PropertyChanged(self, property, value):
2017
1369
"D-Bus signal"
2018
1370
pass
2019
1371
2020
1372
# GotSecret - signal
2021
1373
@dbus.service.signal(_interface)
2022
1374
def GotSecret(self):
2025
1377
server to mandos-client
2026
1378
"""
2027
1379
pass
2028
1380
2029
1381
# Rejected - signal
2030
1382
@dbus.service.signal(_interface, signature="s")
2031
1383
def Rejected(self, reason):
2032
1384
"D-Bus signal"
2033
1385
pass
2034
1386
2035
1387
# NeedApproval - signal
2036
1388
@dbus.service.signal(_interface, signature="tb")
2037
1389
def NeedApproval(self, timeout, default):
2038
1390
"D-Bus signal"
2039
1391
return self.need_approval()
2040
2041
# Methods
2042
1392
1393
## Methods
1394
2043
1395
# Approve - method
2044
1396
@dbus.service.method(_interface, in_signature="b")
2045
1397
def Approve(self, value):
2046
1398
self.approve(value)
2047
1399
2048
1400
# CheckedOK - method
2049
1401
@dbus.service.method(_interface)
2050
1402
def CheckedOK(self):
2051
1403
self.checked_ok()
2052
1404
2053
1405
# Enable - method
2054
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2055
1406
@dbus.service.method(_interface)
2056
1407
def Enable(self):
2057
1408
"D-Bus method"
2058
1409
self.enable()
2059
1410
2060
1411
# StartChecker - method
2061
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2062
1412
@dbus.service.method(_interface)
2063
1413
def StartChecker(self):
2064
1414
"D-Bus method"
2065
1415
self.start_checker()
2066
1416
2067
1417
# Disable - method
2068
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2069
1418
@dbus.service.method(_interface)
2070
1419
def Disable(self):
2071
1420
"D-Bus method"
2072
1421
self.disable()
2073
1422
2074
1423
# StopChecker - method
2075
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2076
1424
@dbus.service.method(_interface)
2077
1425
def StopChecker(self):
2078
1426
self.stop_checker()
2079
2080
# Properties
2081
1427
1428
## Properties
1429
2082
1430
# ApprovalPending - property
2083
1431
@dbus_service_property(_interface, signature="b", access="read")
2084
1432
def ApprovalPending_dbus_property(self):
2085
1433
return dbus.Boolean(bool(self.approvals_pending))
2086
1434
2087
1435
# ApprovedByDefault - property
2088
@dbus_service_property(_interface,
2089
signature="b",
1436
@dbus_service_property(_interface, signature="b",
2090
1437
access="readwrite")
2091
1438
def ApprovedByDefault_dbus_property(self, value=None):
2092
1439
if value is None: # get
2093
1440
return dbus.Boolean(self.approved_by_default)
2094
1441
self.approved_by_default = bool(value)
2095
1442
2096
1443
# ApprovalDelay - property
2097
@dbus_service_property(_interface,
2098
signature="t",
1444
@dbus_service_property(_interface, signature="t",
2099
1445
access="readwrite")
2100
1446
def ApprovalDelay_dbus_property(self, value=None):
2101
1447
if value is None: # get
2102
return dbus.UInt64(self.approval_delay.total_seconds()
2103
* 1000)
1448
return dbus.UInt64(self.approval_delay_milliseconds())
2104
1449
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2105
1450
2106
1451
# ApprovalDuration - property
2107
@dbus_service_property(_interface,
2108
signature="t",
1452
@dbus_service_property(_interface, signature="t",
2109
1453
access="readwrite")
2110
1454
def ApprovalDuration_dbus_property(self, value=None):
2111
1455
if value is None: # get
2112
return dbus.UInt64(self.approval_duration.total_seconds()
2113
* 1000)
1456
return dbus.UInt64(timedelta_to_milliseconds(
1457
self.approval_duration))
2114
1458
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2115
1459
2116
1460
# Name - property
2117
@dbus_annotations(
2118
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2119
1461
@dbus_service_property(_interface, signature="s", access="read")
2120
1462
def Name_dbus_property(self):
2121
1463
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
1464
2130
1465
# Fingerprint - property
2131
@dbus_annotations(
2132
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2133
1466
@dbus_service_property(_interface, signature="s", access="read")
2134
1467
def Fingerprint_dbus_property(self):
2135
1468
return dbus.String(self.fingerprint)
2136
1469
2137
1470
# Host - property
2138
@dbus_service_property(_interface,
2139
signature="s",
1471
@dbus_service_property(_interface, signature="s",
2140
1472
access="readwrite")
2141
1473
def Host_dbus_property(self, value=None):
2142
1474
if value is None: # get
2143
1475
return dbus.String(self.host)
2144
self.host = str(value)
2145
1476
self.host = unicode(value)
1477
2146
1478
# Created - property
2147
@dbus_annotations(
2148
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2149
1479
@dbus_service_property(_interface, signature="s", access="read")
2150
1480
def Created_dbus_property(self):
2151
1481
return datetime_to_dbus(self.created)
2152
1482
2153
1483
# LastEnabled - property
2154
1484
@dbus_service_property(_interface, signature="s", access="read")
2155
1485
def LastEnabled_dbus_property(self):
2156
1486
return datetime_to_dbus(self.last_enabled)
2157
1487
2158
1488
# Enabled - property
2159
@dbus_service_property(_interface,
2160
signature="b",
1489
@dbus_service_property(_interface, signature="b",
2161
1490
access="readwrite")
2162
1491
def Enabled_dbus_property(self, value=None):
2163
1492
if value is None: # get
2166
1495
self.enable()
2167
1496
else:
2168
1497
self.disable()
2169
1498
2170
1499
# LastCheckedOK - property
2171
@dbus_service_property(_interface,
2172
signature="s",
1500
@dbus_service_property(_interface, signature="s",
2173
1501
access="readwrite")
2174
1502
def LastCheckedOK_dbus_property(self, value=None):
2175
1503
if value is not None:
2176
1504
self.checked_ok()
2177
1505
return
2178
1506
return datetime_to_dbus(self.last_checked_ok)
2179
1507
2180
1508
# LastCheckerStatus - property
2181
@dbus_service_property(_interface, signature="n", access="read")
1509
@dbus_service_property(_interface, signature="n",
1510
access="read")
2182
1511
def LastCheckerStatus_dbus_property(self):
2183
1512
return dbus.Int16(self.last_checker_status)
2184
1513
2185
1514
# Expires - property
2186
1515
@dbus_service_property(_interface, signature="s", access="read")
2187
1516
def Expires_dbus_property(self):
2188
1517
return datetime_to_dbus(self.expires)
2189
1518
2190
1519
# LastApprovalRequest - property
2191
1520
@dbus_service_property(_interface, signature="s", access="read")
2192
1521
def LastApprovalRequest_dbus_property(self):
2193
1522
return datetime_to_dbus(self.last_approval_request)
2194
1523
2195
1524
# Timeout - property
2196
@dbus_service_property(_interface,
2197
signature="t",
1525
@dbus_service_property(_interface, signature="t",
2198
1526
access="readwrite")
2199
1527
def Timeout_dbus_property(self, value=None):
2200
1528
if value is None: # get
2201
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2202
old_timeout = self.timeout
1529
return dbus.UInt64(self.timeout_milliseconds())
2203
1530
self.timeout = datetime.timedelta(0, 0, 0, value)
2204
# Reschedule disabling
1531
# Reschedule timeout
2205
1532
if self.enabled:
2206
1533
now = datetime.datetime.utcnow()
2207
self.expires += self.timeout - old_timeout
2208
if self.expires <= now:
1534
time_to_die = timedelta_to_milliseconds(
1535
(self.last_checked_ok + self.timeout) - now)
1536
if time_to_die <= 0:
2209
1537
# The timeout has passed
2210
1538
self.disable()
2211
1539
else:
1540
self.expires = (now +
1541
datetime.timedelta(milliseconds =
1542
time_to_die))
2212
1543
if (getattr(self, "disable_initiator_tag", None)
2213
1544
is None):
2214
1545
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
1546
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (gobject.timeout_add
1548
(time_to_die,
1549
self.disable))
1550
2220
1551
# ExtendedTimeout - property
2221
@dbus_service_property(_interface,
2222
signature="t",
1552
@dbus_service_property(_interface, signature="t",
2223
1553
access="readwrite")
2224
1554
def ExtendedTimeout_dbus_property(self, value=None):
2225
1555
if value is None: # get
2226
return dbus.UInt64(self.extended_timeout.total_seconds()
2227
* 1000)
1556
return dbus.UInt64(self.extended_timeout_milliseconds())
2228
1557
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2229
1558
2230
1559
# Interval - property
2231
@dbus_service_property(_interface,
2232
signature="t",
1560
@dbus_service_property(_interface, signature="t",
2233
1561
access="readwrite")
2234
1562
def Interval_dbus_property(self, value=None):
2235
1563
if value is None: # get
2236
return dbus.UInt64(self.interval.total_seconds() * 1000)
1564
return dbus.UInt64(self.interval_milliseconds())
2237
1565
self.interval = datetime.timedelta(0, 0, 0, value)
2238
1566
if getattr(self, "checker_initiator_tag", None) is None:
2239
1567
return
2240
1568
if self.enabled:
2241
1569
# 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
1570
gobject.source_remove(self.checker_initiator_tag)
1571
self.checker_initiator_tag = (gobject.timeout_add
1572
(value, self.start_checker))
1573
self.start_checker() # Start one now, too
1574
2247
1575
# Checker - property
2248
@dbus_service_property(_interface,
2249
signature="s",
1576
@dbus_service_property(_interface, signature="s",
2250
1577
access="readwrite")
2251
1578
def Checker_dbus_property(self, value=None):
2252
1579
if value is None: # get
2253
1580
return dbus.String(self.checker_command)
2254
self.checker_command = str(value)
2255
1581
self.checker_command = unicode(value)
1582
2256
1583
# CheckerRunning - property
2257
@dbus_service_property(_interface,
2258
signature="b",
1584
@dbus_service_property(_interface, signature="b",
2259
1585
access="readwrite")
2260
1586
def CheckerRunning_dbus_property(self, value=None):
2261
1587
if value is None: # get
2264
1590
self.start_checker()
2265
1591
else:
2266
1592
self.stop_checker()
2267
1593
2268
1594
# ObjectPath - property
2269
@dbus_annotations(
2270
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2271
"org.freedesktop.DBus.Deprecated": "true"})
2272
1595
@dbus_service_property(_interface, signature="o", access="read")
2273
1596
def ObjectPath_dbus_property(self):
2274
return self.dbus_object_path # is already a dbus.ObjectPath
2275
1597
return self.dbus_object_path # is already a dbus.ObjectPath
1598
2276
1599
# 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)
1600
@dbus_service_property(_interface, signature="ay",
1601
access="write", byte_arrays=True)
2284
1602
def Secret_dbus_property(self, value):
2285
self.secret = bytes(value)
2286
1603
self.secret = str(value)
1604
2287
1605
del _interface
2288
1606
2289
1607
2290
class ProxyClient:
2291
def __init__(self, child_pipe, key_id, fpr, address):
1608
class ProxyClient(object):
1609
def __init__(self, child_pipe, fpr, address):
2292
1610
self._pipe = child_pipe
2293
self._pipe.send(("init", key_id, fpr, address))
1611
self._pipe.send(('init', fpr, address))
2294
1612
if not self._pipe.recv():
2295
raise KeyError(key_id or fpr)
2296
1613
raise KeyError()
1614
2297
1615
def __getattribute__(self, name):
2298
if name == "_pipe":
1616
if name == '_pipe':
2299
1617
return super(ProxyClient, self).__getattribute__(name)
2300
self._pipe.send(("getattr", name))
1618
self._pipe.send(('getattr', name))
2301
1619
data = self._pipe.recv()
2302
if data[0] == "data":
1620
if data[0] == 'data':
2303
1621
return data[1]
2304
if data[0] == "function":
2305
1622
if data[0] == 'function':
2306
1623
def func(*args, **kwargs):
2307
self._pipe.send(("funcall", name, args, kwargs))
1624
self._pipe.send(('funcall', name, args, kwargs))
2308
1625
return self._pipe.recv()[1]
2309
2310
1626
return func
2311
1627
2312
1628
def __setattr__(self, name, value):
2313
if name == "_pipe":
1629
if name == '_pipe':
2314
1630
return super(ProxyClient, self).__setattr__(name, value)
2315
self._pipe.send(("setattr", name, value))
1631
self._pipe.send(('setattr', name, value))
2316
1632
2317
1633
2318
1634
class ClientHandler(socketserver.BaseRequestHandler, object):
2319
1635
"""A class to handle client connections.
2320
1636
2321
1637
Instantiated once for each connection to handle it.
2322
1638
Note: This will run in its own forked process."""
2323
1639
2324
1640
def handle(self):
2325
1641
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"))
1642
logger.info("TCP connection from: %s",
1643
unicode(self.client_address))
1644
logger.debug("Pipe FD: %d",
1645
self.server.child_pipe.fileno())
1646
1647
session = (gnutls.connection
1648
.ClientSession(self.request,
1649
gnutls.connection
1650
.X509Credentials()))
1651
1652
# Note: gnutls.connection.X509Credentials is really a
1653
# generic GnuTLS certificate credentials object so long as
1654
# no X.509 keys are added to it. Therefore, we can use it
1655
# here despite using OpenPGP certificates.
1656
1657
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1658
# "+AES-256-CBC", "+SHA1",
1659
# "+COMP-NULL", "+CTYPE-OPENPGP",
1660
# "+DHE-DSS"))
2336
1661
# Use a fallback default, since this MUST be set.
2337
1662
priority = self.server.gnutls_priority
2338
1663
if priority is None:
2339
1664
priority = "NORMAL"
2340
gnutls.priority_set_direct(session,
2341
priority.encode("utf-8"), None)
2342
1665
(gnutls.library.functions
1666
.gnutls_priority_set_direct(session._c_object,
1667
priority, None))
1668
2343
1669
# Start communication using the Mandos protocol
2344
1670
# Get protocol number
2345
1671
line = self.request.makefile().readline()
2346
log.debug("Protocol version: %r", line)
1672
logger.debug("Protocol version: %r", line)
2347
1673
try:
2348
1674
if int(line.strip().split()[0]) > 1:
2349
raise RuntimeError(line)
1675
raise RuntimeError
2350
1676
except (ValueError, IndexError, RuntimeError) as error:
2351
log.error("Unknown protocol version: %s", error)
1677
logger.error("Unknown protocol version: %s", error)
2352
1678
return
2353
1679
2354
1680
# Start GnuTLS connection
2355
1681
try:
2356
1682
session.handshake()
2357
except gnutls.Error as error:
2358
log.warning("Handshake failed: %s", error)
1683
except gnutls.errors.GNUTLSError as error:
1684
logger.warning("Handshake failed: %s", error)
2359
1685
# Do not run session.bye() here: the session is not
2360
1686
# established. Just abandon the request.
2361
1687
return
2362
log.debug("Handshake succeeded")
2363
1688
logger.debug("Handshake succeeded")
1689
2364
1690
approval_required = False
2365
1691
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,
1692
try:
1693
fpr = self.fingerprint(self.peer_certificate
1694
(session))
1695
except (TypeError,
1696
gnutls.errors.GNUTLSError) as error:
1697
logger.warning("Bad certificate: %s", error)
1698
return
1699
logger.debug("Fingerprint: %s", fpr)
1700
1701
try:
1702
client = ProxyClient(child_pipe, fpr,
2390
1703
self.client_address)
2391
1704
except KeyError:
2392
1705
return
2393
1706
2394
1707
if client.approval_delay:
2395
1708
delay = client.approval_delay
2396
1709
client.approvals_pending += 1
2397
1710
approval_required = True
2398
1711
2399
1712
while True:
2400
1713
if not client.enabled:
2401
log.info("Client %s is disabled", client.name)
1714
logger.info("Client %s is disabled",
1715
client.name)
2402
1716
if self.server.use_dbus:
2403
1717
# Emit D-Bus signal
2404
1718
client.Rejected("Disabled")
2405
1719
return
2406
1720
2407
1721
if client.approved or not client.approval_delay:
2408
# We are approved or approval is disabled
1722
#We are approved or approval is disabled
2409
1723
break
2410
1724
elif client.approved is None:
2411
log.info("Client %s needs approval",
2412
client.name)
1725
logger.info("Client %s needs approval",
1726
client.name)
2413
1727
if self.server.use_dbus:
2414
1728
# Emit D-Bus signal
2415
1729
client.NeedApproval(
2416
client.approval_delay.total_seconds()
2417
* 1000, client.approved_by_default)
1730
client.approval_delay_milliseconds(),
1731
client.approved_by_default)
2418
1732
else:
2419
log.warning("Client %s was not approved",
2420
client.name)
1733
logger.warning("Client %s was not approved",
1734
client.name)
2421
1735
if self.server.use_dbus:
2422
1736
# Emit D-Bus signal
2423
1737
client.Rejected("Denied")
2424
1738
return
2425
2426
# wait until timeout or approved
1739
1740
#wait until timeout or approved
2427
1741
time = datetime.datetime.now()
2428
1742
client.changedstate.acquire()
2429
client.changedstate.wait(delay.total_seconds())
1743
(client.changedstate.wait
1744
(float(client.timedelta_to_milliseconds(delay)
1745
/ 1000)))
2430
1746
client.changedstate.release()
2431
1747
time2 = datetime.datetime.now()
2432
1748
if (time2 - time) >= delay:
2433
1749
if not client.approved_by_default:
2434
log.warning("Client %s timed out while"
2435
" waiting for approval",
2436
client.name)
1750
logger.warning("Client %s timed out while"
1751
" waiting for approval",
1752
client.name)
2437
1753
if self.server.use_dbus:
2438
1754
# Emit D-Bus signal
2439
1755
client.Rejected("Approval timed out")
2442
1758
break
2443
1759
else:
2444
1760
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)
1761
1762
sent_size = 0
1763
while sent_size < len(client.secret):
1764
try:
1765
sent = session.send(client.secret[sent_size:])
1766
except gnutls.errors.GNUTLSError as error:
1767
logger.warning("gnutls send failed",
1768
exc_info=error)
1769
return
1770
logger.debug("Sent: %d, remaining: %d",
1771
sent, len(client.secret)
1772
- (sent_size + sent))
1773
sent_size += sent
1774
1775
logger.info("Sending secret to %s", client.name)
2453
1776
# bump the timeout using extended_timeout
2454
1777
client.bump_timeout(client.extended_timeout)
2455
1778
if self.server.use_dbus:
2456
1779
# Emit D-Bus signal
2457
1780
client.GotSecret()
2458
1781
2459
1782
finally:
2460
1783
if approval_required:
2461
1784
client.approvals_pending -= 1
2462
1785
try:
2463
1786
session.bye()
2464
except gnutls.Error as error:
2465
log.warning("GnuTLS bye failed", exc_info=error)
2466
1787
except gnutls.errors.GNUTLSError as error:
1788
logger.warning("GnuTLS bye failed",
1789
exc_info=error)
1790
2467
1791
@staticmethod
2468
1792
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""
1793
"Return the peer's OpenPGP certificate as a bytestring"
1794
# If not an OpenPGP certificate...
1795
if (gnutls.library.functions
1796
.gnutls_certificate_type_get(session._c_object)
1797
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1798
# ...do the normal thing
1799
return session.peer_certificate
2485
1800
list_size = ctypes.c_uint(1)
2486
cert_list = (gnutls.certificate_get_peers
2487
(session, ctypes.byref(list_size)))
1801
cert_list = (gnutls.library.functions
1802
.gnutls_certificate_get_peers
1803
(session._c_object, ctypes.byref(list_size)))
2488
1804
if not bool(cert_list) and list_size.value != 0:
2489
raise gnutls.Error("error getting peer certificate")
1805
raise gnutls.errors.GNUTLSError("error getting peer"
1806
" certificate")
2490
1807
if list_size.value == 0:
2491
1808
return None
2492
1809
cert = cert_list[0]
2493
1810
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
1811
2530
1812
@staticmethod
2531
1813
def fingerprint(openpgp):
2532
1814
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2533
1815
# 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)))
1816
datum = (gnutls.library.types
1817
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1818
ctypes.POINTER
1819
(ctypes.c_ubyte)),
1820
ctypes.c_uint(len(openpgp))))
2538
1821
# New empty GnuTLS certificate
2539
crt = gnutls.openpgp_crt_t()
2540
gnutls.openpgp_crt_init(ctypes.byref(crt))
1822
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1823
(gnutls.library.functions
1824
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2541
1825
# Import the OpenPGP public key into the certificate
2542
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2543
gnutls.OPENPGP_FMT_RAW)
1826
(gnutls.library.functions
1827
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1828
gnutls.library.constants
1829
.GNUTLS_OPENPGP_FMT_RAW))
2544
1830
# Verify the self signature in the key
2545
1831
crtverify = ctypes.c_uint()
2546
gnutls.openpgp_crt_verify_self(crt, 0,
2547
ctypes.byref(crtverify))
1832
(gnutls.library.functions
1833
.gnutls_openpgp_crt_verify_self(crt, 0,
1834
ctypes.byref(crtverify)))
2548
1835
if crtverify.value != 0:
2549
gnutls.openpgp_crt_deinit(crt)
2550
raise gnutls.CertificateSecurityError(code
2551
=crtverify.value)
1836
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1837
raise (gnutls.errors.CertificateSecurityError
1838
("Verify failed"))
2552
1839
# New buffer for the fingerprint
2553
1840
buf = ctypes.create_string_buffer(20)
2554
1841
buf_len = ctypes.c_size_t()
2555
1842
# Get the fingerprint from the certificate into the buffer
2556
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2557
ctypes.byref(buf_len))
1843
(gnutls.library.functions
1844
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1845
ctypes.byref(buf_len)))
2558
1846
# Deinit the certificate
2559
gnutls.openpgp_crt_deinit(crt)
1847
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2560
1848
# Convert the buffer to a Python bytestring
2561
1849
fpr = ctypes.string_at(buf, buf_len.value)
2562
1850
# Convert the bytestring to hexadecimal notation
2564
1852
return hex_fpr
2565
1853
2566
1854
2567
class MultiprocessingMixIn:
1855
class MultiprocessingMixIn(object):
2568
1856
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2569
2570
1857
def sub_process_main(self, request, address):
2571
1858
try:
2572
1859
self.finish_request(request, address)
2573
1860
except Exception:
2574
1861
self.handle_error(request, address)
2575
1862
self.close_request(request)
2576
1863
2577
1864
def process_request(self, request, address):
2578
1865
"""Start a new process to process the request."""
2579
proc = multiprocessing.Process(target=self.sub_process_main,
2580
args=(request, address))
1866
proc = multiprocessing.Process(target = self.sub_process_main,
1867
args = (request,
1868
address))
2581
1869
proc.start()
2582
1870
return proc
2583
1871
2584
1872
2585
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1873
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2586
1874
""" adds a pipe to the MixIn """
2587
2588
1875
def process_request(self, request, client_address):
2589
1876
"""Overrides and wraps the original process_request().
2590
1877
2591
1878
This function creates a new pipe in self.pipe
2592
1879
"""
2593
1880
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2594
1881
2595
1882
proc = MultiprocessingMixIn.process_request(self, request,
2596
1883
client_address)
2597
1884
self.child_pipe.close()
2598
1885
self.add_pipe(parent_pipe, proc)
2599
1886
2600
1887
def add_pipe(self, parent_pipe, proc):
2601
1888
"""Dummy function; override as necessary"""
2602
raise NotImplementedError()
1889
raise NotImplementedError
2603
1890
2604
1891
2605
1892
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2606
socketserver.TCPServer):
2607
"""IPv6-capable TCP server. Accepts None as address and/or port
2608
1893
socketserver.TCPServer, object):
1894
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1895
2609
1896
Attributes:
2610
1897
enabled: Boolean; whether this server is activated yet
2611
1898
interface: None or a network interface name (string)
2612
1899
use_ipv6: Boolean; to use IPv6 or not
2613
1900
"""
2614
2615
1901
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
"""
1902
interface=None, use_ipv6=True):
2622
1903
self.interface = interface
2623
1904
if use_ipv6:
2624
1905
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
1906
socketserver.TCPServer.__init__(self, server_address,
2653
1907
RequestHandlerClass)
2654
2655
1908
def server_bind(self):
2656
1909
"""This overrides the normal server_bind() function
2657
1910
to bind to an interface if one was specified, and also NOT to
2658
1911
bind to an address or port if they were not specified."""
2659
global SO_BINDTODEVICE
2660
1912
if self.interface is not None:
2661
1913
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
1914
logger.error("SO_BINDTODEVICE does not exist;"
1915
" cannot bind to interface %s",
1916
self.interface)
1917
else:
1918
try:
1919
self.socket.setsockopt(socket.SOL_SOCKET,
1920
SO_BINDTODEVICE,
1921
str(self.interface
1922
+ '\0'))
1923
except socket.error as error:
1924
if error[0] == errno.EPERM:
1925
logger.error("No permission to"
1926
" bind to interface %s",
1927
self.interface)
1928
elif error[0] == errno.ENOPROTOOPT:
1929
logger.error("SO_BINDTODEVICE not available;"
1930
" cannot bind to interface %s",
1931
self.interface)
1932
else:
1933
raise
2682
1934
# Only bind(2) the socket if we really need to.
2683
1935
if self.server_address[0] or self.server_address[1]:
2684
if self.server_address[1]:
2685
self.allow_reuse_address = True
2686
1936
if not self.server_address[0]:
2687
1937
if self.address_family == socket.AF_INET6:
2688
any_address = "::" # in6addr_any
1938
any_address = "::" # in6addr_any
2689
1939
else:
2690
any_address = "0.0.0.0" # INADDR_ANY
1940
any_address = socket.INADDR_ANY
2691
1941
self.server_address = (any_address,
2692
1942
self.server_address[1])
2693
1943
elif not self.server_address[1]:
2694
self.server_address = (self.server_address[0], 0)
1944
self.server_address = (self.server_address[0],
1945
0)
2695
1946
# if self.interface:
2696
1947
# self.server_address = (self.server_address[0],
2697
1948
# 0, # port
2703
1954
2704
1955
class MandosServer(IPv6_TCPServer):
2705
1956
"""Mandos server.
2706
1957
2707
1958
Attributes:
2708
1959
clients: set of Client objects
2709
1960
gnutls_priority GnuTLS priority string
2710
1961
use_dbus: Boolean; to emit D-Bus signals or not
2711
2712
Assumes a GLib.MainLoop event loop.
1962
1963
Assumes a gobject.MainLoop event loop.
2713
1964
"""
2714
2715
1965
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):
1966
interface=None, use_ipv6=True, clients=None,
1967
gnutls_priority=None, use_dbus=True):
2722
1968
self.enabled = False
2723
1969
self.clients = clients
2724
1970
if self.clients is None:
2727
1973
self.gnutls_priority = gnutls_priority
2728
1974
IPv6_TCPServer.__init__(self, server_address,
2729
1975
RequestHandlerClass,
2730
interface=interface,
2731
use_ipv6=use_ipv6,
2732
socketfd=socketfd)
2733
1976
interface = interface,
1977
use_ipv6 = use_ipv6)
2734
1978
def server_activate(self):
2735
1979
if self.enabled:
2736
1980
return socketserver.TCPServer.server_activate(self)
2737
1981
2738
1982
def enable(self):
2739
1983
self.enabled = True
2740
1984
2741
1985
def add_pipe(self, parent_pipe, proc):
2742
1986
# 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):
1987
gobject.io_add_watch(parent_pipe.fileno(),
1988
gobject.IO_IN | gobject.IO_HUP,
1989
functools.partial(self.handle_ipc,
1990
parent_pipe =
1991
parent_pipe,
1992
proc = proc))
1993
1994
def handle_ipc(self, source, condition, parent_pipe=None,
1995
proc = None, client_object=None):
1996
condition_names = {
1997
gobject.IO_IN: "IN", # There is data to read.
1998
gobject.IO_OUT: "OUT", # Data can be written (without
1999
# blocking).
2000
gobject.IO_PRI: "PRI", # There is urgent data to read.
2001
gobject.IO_ERR: "ERR", # Error condition.
2002
gobject.IO_HUP: "HUP" # Hung up (the connection has been
2003
# broken, usually for pipes and
2004
# sockets).
2005
}
2006
conditions_string = ' | '.join(name
2007
for cond, name in
2008
condition_names.iteritems()
2009
if cond & condition)
2754
2010
# error, or the other end of multiprocessing.Pipe has closed
2755
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2011
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2756
2012
# Wait for other process to exit
2757
2013
proc.join()
2758
2014
return False
2759
2015
2760
2016
# Read a request from the child
2761
2017
request = parent_pipe.recv()
2762
2018
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:
2019
2020
if command == 'init':
2021
fpr = request[1]
2022
address = request[2]
2023
2024
for c in self.clients.itervalues():
2025
if c.fingerprint == fpr:
2777
2026
client = c
2778
2027
break
2779
2028
else:
2780
log.info("Client not found for key ID: %s, address:"
2781
" %s", key_id or fpr, address)
2029
logger.info("Client not found for fingerprint: %s, ad"
2030
"dress: %s", fpr, address)
2782
2031
if self.use_dbus:
2783
2032
# Emit D-Bus signal
2784
mandos_dbus_service.ClientNotFound(key_id or fpr,
2033
mandos_dbus_service.ClientNotFound(fpr,
2785
2034
address[0])
2786
2035
parent_pipe.send(False)
2787
2036
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))
2037
2038
gobject.io_add_watch(parent_pipe.fileno(),
2039
gobject.IO_IN | gobject.IO_HUP,
2040
functools.partial(self.handle_ipc,
2041
parent_pipe =
2042
parent_pipe,
2043
proc = proc,
2044
client_object =
2045
client))
2796
2046
parent_pipe.send(True)
2797
2047
# remove the old hook in favor of the new above hook on
2798
2048
# same fileno
2799
2049
return False
2800
if command == "funcall":
2050
if command == 'funcall':
2801
2051
funcname = request[1]
2802
2052
args = request[2]
2803
2053
kwargs = request[3]
2804
2805
parent_pipe.send(("data", getattr(client_object,
2054
2055
parent_pipe.send(('data', getattr(client_object,
2806
2056
funcname)(*args,
2807
**kwargs)))
2808
2809
if command == "getattr":
2057
**kwargs)))
2058
2059
if command == 'getattr':
2810
2060
attrname = request[1]
2811
if isinstance(client_object.__getattribute__(attrname),
2812
collections.abc.Callable):
2813
parent_pipe.send(("function", ))
2061
if callable(client_object.__getattribute__(attrname)):
2062
parent_pipe.send(('function',))
2814
2063
else:
2815
parent_pipe.send((
2816
"data", client_object.__getattribute__(attrname)))
2817
2818
if command == "setattr":
2064
parent_pipe.send(('data', client_object
2065
.__getattribute__(attrname)))
2066
2067
if command == 'setattr':
2819
2068
attrname = request[1]
2820
2069
value = request[2]
2821
2070
setattr(client_object, attrname, value)
2822
2071
2823
2072
return True
2824
2073
2825
2074
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
2075
def string_to_delta(interval):
2928
2076
"""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
2077
2078
>>> string_to_delta('7d')
2079
datetime.timedelta(7)
2080
>>> string_to_delta('60s')
2081
datetime.timedelta(0, 60)
2082
>>> string_to_delta('60m')
2083
datetime.timedelta(0, 3600)
2084
>>> string_to_delta('24h')
2085
datetime.timedelta(1)
2086
>>> string_to_delta('1w')
2087
datetime.timedelta(7)
2088
>>> string_to_delta('5m 30s')
2089
datetime.timedelta(0, 330)
2942
2090
"""
2943
2944
try:
2945
return rfc3339_duration_to_delta(interval)
2946
except ValueError:
2947
pass
2948
2949
2091
timevalue = datetime.timedelta(0)
2950
2092
for s in interval.split():
2951
2093
try:
2952
suffix = s[-1]
2094
suffix = unicode(s[-1])
2953
2095
value = int(s[:-1])
2954
2096
if suffix == "d":
2955
2097
delta = datetime.timedelta(value)
2962
2104
elif suffix == "w":
2963
2105
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2964
2106
else:
2965
raise ValueError("Unknown suffix {!r}".format(suffix))
2966
except IndexError as e:
2107
raise ValueError("Unknown suffix {0!r}"
2108
.format(suffix))
2109
except (ValueError, IndexError) as e:
2967
2110
raise ValueError(*(e.args))
2968
2111
timevalue += delta
2969
2112
return timevalue
2970
2113
2971
2114
2972
def daemon(nochdir=False, noclose=False):
2115
def daemon(nochdir = False, noclose = False):
2973
2116
"""See daemon(3). Standard BSD Unix function.
2974
2117
2975
2118
This should really exist as os.daemon, but it doesn't (yet)."""
2976
2119
if os.fork():
2977
2120
sys.exit()
2985
2128
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2986
2129
if not stat.S_ISCHR(os.fstat(null).st_mode):
2987
2130
raise OSError(errno.ENODEV,
2988
"{} not a character device"
2131
"{0} not a character device"
2989
2132
.format(os.devnull))
2990
2133
os.dup2(null, sys.stdin.fileno())
2991
2134
os.dup2(null, sys.stdout.fileno())
2995
2138
2996
2139
2997
2140
def main():
2998
2141
2999
2142
##################################################################
3000
2143
# Parsing of options, both command line and config file
3001
2144
3002
2145
parser = argparse.ArgumentParser()
3003
2146
parser.add_argument("-v", "--version", action="version",
3004
version="%(prog)s {}".format(version),
2147
version = "%(prog)s {0}".format(version),
3005
2148
help="show version number and exit")
3006
2149
parser.add_argument("-i", "--interface", metavar="IF",
3007
2150
help="Bind to interface IF")
3013
2156
help="Run self-test")
3014
2157
parser.add_argument("--debug", action="store_true",
3015
2158
help="Debug mode; run in foreground and log"
3016
" to terminal", default=None)
2159
" to terminal")
3017
2160
parser.add_argument("--debuglevel", metavar="LEVEL",
3018
2161
help="Debug level for stdout output")
3019
2162
parser.add_argument("--priority", help="GnuTLS"
3026
2169
" files")
3027
2170
parser.add_argument("--no-dbus", action="store_false",
3028
2171
dest="use_dbus", help="Do not provide D-Bus"
3029
" system bus interface", default=None)
2172
" system bus interface")
3030
2173
parser.add_argument("--no-ipv6", action="store_false",
3031
dest="use_ipv6", help="Do not use IPv6",
3032
default=None)
2174
dest="use_ipv6", help="Do not use IPv6")
3033
2175
parser.add_argument("--no-restore", action="store_false",
3034
2176
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")
2177
" state")
3039
2178
parser.add_argument("--statedir", metavar="DIR",
3040
2179
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
2180
3047
2181
options = parser.parse_args()
3048
2182
2183
if options.check:
2184
import doctest
2185
doctest.testmod()
2186
sys.exit()
2187
3049
2188
# 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
2189
server_defaults = { "interface": "",
2190
"address": "",
2191
"port": "",
2192
"debug": "False",
2193
"priority":
2194
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2195
"servicename": "Mandos",
2196
"use_dbus": "True",
2197
"use_ipv6": "True",
2198
"debuglevel": "",
2199
"restore": "True",
2200
"statedir": "/var/lib/mandos"
2201
}
2202
3073
2203
# Parse config file for server-global settings
3074
server_config = configparser.ConfigParser(server_defaults)
2204
server_config = configparser.SafeConfigParser(server_defaults)
3075
2205
del server_defaults
3076
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3077
# Convert the ConfigParser object to a dict
2206
server_config.read(os.path.join(options.configdir,
2207
"mandos.conf"))
2208
# Convert the SafeConfigParser object to a dict
3078
2209
server_settings = server_config.defaults()
3079
2210
# Use the appropriate methods on the non-string config options
3080
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3081
"foreground", "zeroconf"):
2211
for option in ("debug", "use_dbus", "use_ipv6"):
3082
2212
server_settings[option] = server_config.getboolean("DEFAULT",
3083
2213
option)
3084
2214
if server_settings["port"]:
3085
2215
server_settings["port"] = server_config.getint("DEFAULT",
3086
2216
"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
2217
del server_config
3097
2218
3098
2219
# Override the settings from the config file with command line
3099
2220
# options, if set.
3100
2221
for option in ("interface", "address", "port", "debug",
3101
"priority", "servicename", "configdir", "use_dbus",
3102
"use_ipv6", "debuglevel", "restore", "statedir",
3103
"socket", "foreground", "zeroconf"):
2222
"priority", "servicename", "configdir",
2223
"use_dbus", "use_ipv6", "debuglevel", "restore",
2224
"statedir"):
3104
2225
value = getattr(options, option)
3105
2226
if value is not None:
3106
2227
server_settings[option] = value
3107
2228
del options
3108
2229
# Force all strings to be unicode
3109
2230
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
2231
if type(server_settings[option]) is str:
2232
server_settings[option] = unicode(server_settings[option])
3120
2233
# Now we have our good server settings in "server_settings"
3121
2234
3122
2235
##################################################################
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
2236
3129
2237
# For convenience
3130
2238
debug = server_settings["debug"]
3131
2239
debuglevel = server_settings["debuglevel"]
3133
2241
use_ipv6 = server_settings["use_ipv6"]
3134
2242
stored_state_path = os.path.join(server_settings["statedir"],
3135
2243
stored_state_file)
3136
foreground = server_settings["foreground"]
3137
zeroconf = server_settings["zeroconf"]
3138
2244
3139
2245
if debug:
3140
2246
initlogger(debug, logging.DEBUG)
3141
2247
else:
3144
2250
else:
3145
2251
level = getattr(logging, debuglevel.upper())
3146
2252
initlogger(debug, level)
3147
2253
3148
2254
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
2255
syslogger.setFormatter(logging.Formatter
2256
('Mandos ({0}) [%(process)d]:'
2257
' %(levelname)s: %(message)s'
2258
.format(server_settings
2259
["servicename"])))
2260
3154
2261
# Parse config file with clients
3155
client_config = configparser.ConfigParser(Client.client_defaults)
2262
client_config = configparser.SafeConfigParser(Client
2263
.client_defaults)
3156
2264
client_config.read(os.path.join(server_settings["configdir"],
3157
2265
"clients.conf"))
3158
2266
3159
2267
global mandos_dbus_service
3160
2268
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
2269
2270
tcp_server = MandosServer((server_settings["address"],
2271
server_settings["port"]),
2272
ClientHandler,
2273
interface=(server_settings["interface"]
2274
or None),
2275
use_ipv6=use_ipv6,
2276
gnutls_priority=
2277
server_settings["priority"],
2278
use_dbus=use_dbus)
2279
if not debug:
2280
pidfilename = "/var/run/mandos.pid"
3178
2281
try:
3179
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2282
pidfile = open(pidfilename, "w")
3180
2283
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")):
2284
logger.error("Could not open file %r", pidfilename,
2285
exc_info=e)
2286
2287
for name in ("_mandos", "mandos", "nobody"):
3187
2288
try:
3188
2289
uid = pwd.getpwnam(name).pw_uid
3189
gid = pwd.getpwnam(group).pw_gid
2290
gid = pwd.getpwnam(name).pw_gid
3190
2291
break
3191
2292
except KeyError:
3192
2293
continue
3196
2297
try:
3197
2298
os.setgid(gid)
3198
2299
os.setuid(uid)
3199
log.debug("Did setuid/setgid to %s:%s", uid, gid)
3200
2300
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
2301
if error[0] != errno.EPERM:
2302
raise error
2303
3206
2304
if debug:
3207
2305
# Enable all possible GnuTLS debugging
3208
2306
3209
2307
# "Use a log level over 10 to enable all debugging options."
3210
2308
# - GnuTLS manual
3211
gnutls.global_set_log_level(11)
3212
3213
@gnutls.log_func
2309
gnutls.library.functions.gnutls_global_set_log_level(11)
2310
2311
@gnutls.library.types.gnutls_log_func
3214
2312
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
2313
logger.debug("GnuTLS: %s", string[:-1])
2314
2315
(gnutls.library.functions
2316
.gnutls_global_set_log_function(debug_gnutls))
2317
3220
2318
# Redirect stdin so all checkers get /dev/null
3221
2319
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3222
2320
os.dup2(null, sys.stdin.fileno())
3223
2321
if null > 2:
3224
2322
os.close(null)
3225
2323
3226
2324
# Need to fork before connecting to D-Bus
3227
if not foreground:
2325
if not debug:
3228
2326
# Close all input and output, do double fork, etc.
3229
2327
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
2328
2329
gobject.threads_init()
2330
3236
2331
global main_loop
3237
2332
# From the Avahi example code
3238
2333
DBusGMainLoop(set_as_default=True)
3239
main_loop = GLib.MainLoop()
2334
main_loop = gobject.MainLoop()
3240
2335
bus = dbus.SystemBus()
3241
2336
# End of Avahi example code
3242
2337
if use_dbus:
3243
2338
try:
3244
2339
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)
2340
bus, do_not_queue=True)
2341
old_bus_name = (dbus.service.BusName
2342
("se.bsnet.fukt.Mandos", bus,
2343
do_not_queue=True))
2344
except dbus.exceptions.NameExistsException as e:
2345
logger.error("Disabling D-Bus:", exc_info=e)
3252
2346
use_dbus = False
3253
2347
server_settings["use_dbus"] = False
3254
2348
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
2349
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2350
service = AvahiServiceToSyslog(name =
2351
server_settings["servicename"],
2352
servicetype = "_mandos._tcp",
2353
protocol = protocol, bus = bus)
2354
if server_settings["interface"]:
2355
service.interface = (if_nametoindex
2356
(str(server_settings["interface"])))
2357
3266
2358
global multiprocessing_manager
3267
2359
multiprocessing_manager = multiprocessing.Manager()
3268
2360
3269
2361
client_class = Client
3270
2362
if use_dbus:
3271
client_class = functools.partial(ClientDBus, bus=bus)
3272
2363
client_class = functools.partial(ClientDBus, bus = bus)
2364
3273
2365
client_settings = Client.config_parser(client_config)
3274
2366
old_client_settings = {}
3275
2367
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
2368
3285
2369
# Get client data and settings from last running state.
3286
2370
if server_settings["restore"]:
3287
2371
try:
3288
2372
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"))
2373
clients_data, old_client_settings = (pickle.load
2374
(stored_state))
3339
2375
os.remove(stored_state_path)
3340
2376
except IOError as e:
3341
2377
if e.errno == errno.ENOENT:
3342
log.warning("Could not load persistent state:"
3343
" %s", os.strerror(e.errno))
2378
logger.warning("Could not load persistent state: {0}"
2379
.format(os.strerror(e.errno)))
3344
2380
else:
3345
log.critical("Could not load persistent state:",
3346
exc_info=e)
2381
logger.critical("Could not load persistent state:",
2382
exc_info=e)
3347
2383
raise
3348
2384
except EOFError as e:
3349
log.warning("Could not load persistent state: EOFError:",
3350
exc_info=e)
3351
2385
logger.warning("Could not load persistent state: "
2386
"EOFError:", exc_info=e)
2387
3352
2388
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
2389
for client_name, client in clients_data.iteritems():
3358
2390
# Decide which value to use after restoring saved state.
3359
2391
# We have three different values: Old config file,
3360
2392
# new config file, and saved state.
3365
2397
# For each value in new config, check if it
3366
2398
# differs from the old config value (Except for
3367
2399
# the "secret" attribute)
3368
if (name != "secret"
3369
and (value !=
3370
old_client_settings[client_name][name])):
2400
if (name != "secret" and
2401
value != old_client_settings[client_name]
2402
[name]):
3371
2403
client[name] = value
3372
2404
except KeyError:
3373
2405
pass
3374
2406
3375
2407
# Clients who has passed its expire date can still be
3376
# enabled if its last checker was successful. A Client
2408
# enabled if its last checker was successful. Clients
3377
2409
# whose checker succeeded before we stored its state is
3378
2410
# assumed to have successfully run all checkers during
3379
2411
# downtime.
3380
2412
if client["enabled"]:
3381
2413
if datetime.datetime.utcnow() >= client["expires"]:
3382
2414
if not client["last_checked_ok"]:
3383
log.warning("disabling client %s - Client"
3384
" never performed a successful"
3385
" checker", client_name)
2415
logger.warning(
2416
"disabling client {0} - Client never "
2417
"performed a successful checker"
2418
.format(client_name))
3386
2419
client["enabled"] = False
3387
2420
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"])
2421
logger.warning(
2422
"disabling client {0} - Client "
2423
"last checker failed with error code {1}"
2424
.format(client_name,
2425
client["last_checker_status"]))
3392
2426
client["enabled"] = False
3393
2427
else:
3394
client["expires"] = (
3395
datetime.datetime.utcnow()
3396
+ client["timeout"])
3397
log.debug("Last checker succeeded, keeping %s"
3398
" enabled", client_name)
2428
client["expires"] = (datetime.datetime
2429
.utcnow()
2430
+ client["timeout"])
2431
logger.debug("Last checker succeeded,"
2432
" keeping {0} enabled"
2433
.format(client_name))
3399
2434
try:
3400
client["secret"] = pgp.decrypt(
3401
client["encrypted_secret"],
3402
client_settings[client_name]["secret"])
2435
client["secret"] = (
2436
pgp.decrypt(client["encrypted_secret"],
2437
client_settings[client_name]
2438
["secret"]))
3403
2439
except PGPError:
3404
2440
# 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
2441
logger.debug("Failed to decrypt {0} old secret"
2442
.format(client_name))
2443
client["secret"] = (
2444
client_settings[client_name]["secret"])
2445
3410
2446
# Add/remove clients based on new changes made to config
3411
2447
for client_name in (set(old_client_settings)
3412
2448
- set(client_settings)):
3414
2450
for client_name in (set(client_settings)
3415
2451
- set(old_client_settings)):
3416
2452
clients_data[client_name] = client_settings[client_name]
3417
2453
3418
2454
# Create all client objects
3419
for client_name, client in clients_data.items():
2455
for client_name, client in clients_data.iteritems():
3420
2456
tcp_server.clients[client_name] = client_class(
3421
name=client_name,
3422
settings=client,
3423
server_settings=server_settings)
3424
2457
name = client_name, settings = client)
2458
3425
2459
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
2460
logger.warning("No clients defined")
2461
2462
if not debug:
2463
try:
2464
with pidfile:
2465
pid = os.getpid()
2466
pidfile.write(str(pid) + "\n".encode("utf-8"))
2467
del pidfile
2468
except IOError:
2469
logger.error("Could not write to file %r with PID %d",
2470
pidfilename, pid)
2471
except NameError:
2472
# "pidfile" was never created
2473
pass
3438
2474
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
2475
signal.signal(signal.SIGINT, signal.SIG_IGN)
2476
2477
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2478
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2479
3444
2480
if use_dbus:
3445
3446
@alternate_dbus_interfaces(
3447
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3448
class MandosDBusService(DBusObjectWithObjectManager):
2481
@alternate_dbus_interfaces({"se.recompile.Mandos":
2482
"se.bsnet.fukt.Mandos"})
2483
class MandosDBusService(DBusObjectWithProperties):
3449
2484
"""A D-Bus proxy object"""
3450
3451
2485
def __init__(self):
3452
2486
dbus.service.Object.__init__(self, bus, "/")
3453
3454
2487
_interface = "se.recompile.Mandos"
3455
2488
2489
@dbus_interface_annotations(_interface)
2490
def _foo(self):
2491
return { "org.freedesktop.DBus.Property"
2492
".EmitsChangedSignal":
2493
"false"}
2494
3456
2495
@dbus.service.signal(_interface, signature="o")
3457
2496
def ClientAdded(self, objpath):
3458
2497
"D-Bus signal"
3459
2498
pass
3460
2499
3461
2500
@dbus.service.signal(_interface, signature="ss")
3462
def ClientNotFound(self, key_id, address):
2501
def ClientNotFound(self, fingerprint, address):
3463
2502
"D-Bus signal"
3464
2503
pass
3465
3466
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3467
"true"})
2504
3468
2505
@dbus.service.signal(_interface, signature="os")
3469
2506
def ClientRemoved(self, objpath, name):
3470
2507
"D-Bus signal"
3471
2508
pass
3472
3473
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3474
"true"})
2509
3475
2510
@dbus.service.method(_interface, out_signature="ao")
3476
2511
def GetAllClients(self):
3477
2512
"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"})
2513
return dbus.Array(c.dbus_object_path
2514
for c in
2515
tcp_server.clients.itervalues())
2516
3483
2517
@dbus.service.method(_interface,
3484
2518
out_signature="a{oa{sv}}")
3485
2519
def GetAllClientsWithProperties(self):
3486
2520
"D-Bus method"
3487
2521
return dbus.Dictionary(
3488
{c.dbus_object_path: c.GetAll(
3489
"se.recompile.Mandos.Client")
3490
for c in tcp_server.clients.values()},
2522
((c.dbus_object_path, c.GetAll(""))
2523
for c in tcp_server.clients.itervalues()),
3491
2524
signature="oa{sv}")
3492
2525
3493
2526
@dbus.service.method(_interface, in_signature="o")
3494
2527
def RemoveClient(self, object_path):
3495
2528
"D-Bus method"
3496
for c in tcp_server.clients.values():
2529
for c in tcp_server.clients.itervalues():
3497
2530
if c.dbus_object_path == object_path:
3498
2531
del tcp_server.clients[c.name]
3499
2532
c.remove_from_connection()
3500
# Don't signal the disabling
2533
# Don't signal anything except ClientRemoved
3501
2534
c.disable(quiet=True)
3502
# Emit D-Bus signal for removal
3503
self.client_removed_signal(c)
2535
# Emit D-Bus signal
2536
self.ClientRemoved(object_path, c.name)
3504
2537
return
3505
2538
raise KeyError(object_path)
3506
2539
3507
2540
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
2541
3545
2542
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
2543
3552
2544
def cleanup():
3553
2545
"Cleanup function; run on exit"
3554
if zeroconf:
3555
service.cleanup()
3556
3557
mp.active_children()
3558
wn.close()
2546
service.cleanup()
2547
2548
multiprocessing.active_children()
3559
2549
if not (tcp_server.clients or client_settings):
3560
2550
return
3561
2551
3562
2552
# Store client before exiting. Secrets are encrypted with key
3563
2553
# based on what config file has. If config file is
3564
2554
# removed/edited, old secret will thus be unrecovable.
3565
2555
clients = {}
3566
2556
with PGPEngine() as pgp:
3567
for client in tcp_server.clients.values():
2557
for client in tcp_server.clients.itervalues():
3568
2558
key = client_settings[client.name]["secret"]
3569
2559
client.encrypted_secret = pgp.encrypt(client.secret,
3570
2560
key)
3571
2561
client_dict = {}
3572
2562
3573
2563
# A list of attributes that can not be pickled
3574
2564
# + secret.
3575
exclude = {"bus", "changedstate", "secret",
3576
"checker", "server_settings"}
3577
for name, typ in inspect.getmembers(dbus.service
3578
.Object):
2565
exclude = set(("bus", "changedstate", "secret",
2566
"checker"))
2567
for name, typ in (inspect.getmembers
2568
(dbus.service.Object)):
3579
2569
exclude.add(name)
3580
2570
3581
2571
client_dict["encrypted_secret"] = (client
3582
2572
.encrypted_secret)
3583
2573
for attr in client.client_structure:
3584
2574
if attr not in exclude:
3585
2575
client_dict[attr] = getattr(client, attr)
3586
2576
3587
2577
clients[client.name] = client_dict
3588
2578
del client_settings[client.name]["secret"]
3589
2579
3590
2580
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
2581
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2582
prefix="clients-",
2583
dir=os.path.dirname
2584
(stored_state_path))
2585
with os.fdopen(tempfd, "wb") as stored_state:
2586
pickle.dump((clients, client_settings), stored_state)
3600
2587
os.rename(tempname, stored_state_path)
3601
2588
except (IOError, OSError) as e:
3602
2589
if not debug:
3605
2592
except NameError:
3606
2593
pass
3607
2594
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3608
log.warning("Could not save persistent state: %s",
3609
os.strerror(e.errno))
2595
logger.warning("Could not save persistent state: {0}"
2596
.format(os.strerror(e.errno)))
3610
2597
else:
3611
log.warning("Could not save persistent state:",
3612
exc_info=e)
3613
raise
3614
2598
logger.warning("Could not save persistent state:",
2599
exc_info=e)
2600
raise e
2601
3615
2602
# Delete all clients, and settings from config
3616
2603
while tcp_server.clients:
3617
2604
name, client = tcp_server.clients.popitem()
3618
2605
if use_dbus:
3619
2606
client.remove_from_connection()
3620
# Don't signal the disabling
2607
# Don't signal anything except ClientRemoved
3621
2608
client.disable(quiet=True)
3622
# Emit D-Bus signal for removal
3623
2609
if use_dbus:
3624
mandos_dbus_service.client_removed_signal(client)
2610
# Emit D-Bus signal
2611
mandos_dbus_service.ClientRemoved(client
2612
.dbus_object_path,
2613
client.name)
3625
2614
client_settings.clear()
3626
2615
3627
2616
atexit.register(cleanup)
3628
3629
for client in tcp_server.clients.values():
2617
2618
for client in tcp_server.clients.itervalues():
3630
2619
if use_dbus:
3631
# Emit D-Bus signal for adding
3632
mandos_dbus_service.client_added_signal(client)
2620
# Emit D-Bus signal
2621
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3633
2622
# Need to initiate checking of clients
3634
2623
if client.enabled:
3635
client.init_checker(randomize_start=True)
3636
2624
client.init_checker()
2625
3637
2626
tcp_server.enable()
3638
2627
tcp_server.server_activate()
3639
2628
3640
2629
# Find out what port we got
3641
if zeroconf:
3642
service.port = tcp_server.socket.getsockname()[1]
2630
service.port = tcp_server.socket.getsockname()[1]
3643
2631
if use_ipv6:
3644
log.info("Now listening on address %r, port %d, flowinfo %d,"
3645
" scope_id %d", *tcp_server.socket.getsockname())
2632
logger.info("Now listening on address %r, port %d,"
2633
" flowinfo %d, scope_id %d",
2634
*tcp_server.socket.getsockname())
3646
2635
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
2636
logger.info("Now listening on address %r, port %d",
2637
*tcp_server.socket.getsockname())
2638
2639
#service.interface = tcp_server.socket.getsockname()[3]
2640
3652
2641
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")
2642
# From the Avahi example code
2643
try:
2644
service.activate()
2645
except dbus.exceptions.DBusException as error:
2646
logger.critical("D-Bus Exception", exc_info=error)
2647
cleanup()
2648
sys.exit(1)
2649
# End of Avahi example code
2650
2651
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2652
lambda *args, **kwargs:
2653
(tcp_server.handle_request
2654
(*args[2:], **kwargs) or True))
2655
2656
logger.debug("Starting main loop")
3670
2657
main_loop.run()
3671
2658
except AvahiError as error:
3672
log.critical("Avahi Error", exc_info=error)
2659
logger.critical("Avahi Error", exc_info=error)
3673
2660
cleanup()
3674
2661
sys.exit(1)
3675
2662
except KeyboardInterrupt:
3676
2663
if debug:
3677
2664
print("", file=sys.stderr)
3678
log.debug("Server received KeyboardInterrupt")
3679
log.debug("Server exiting")
2665
logger.debug("Server received KeyboardInterrupt")
2666
logger.debug("Server exiting")
3680
2667
# Must run before the D-Bus bus name gets deregistered
3681
2668
cleanup()
3682
2669
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:
2670
if __name__ == '__main__':
2671
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0