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