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