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