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