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