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