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