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