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