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