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