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