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