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