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