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