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